DescribeProducts-阿里云帮助中心

Queries the data protection score status for cloud products.

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

bdrc:DescribeProducts

none

*All Resource

*

None

Request syntax

GET /api/v1/products HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ResourceCategoryId	string	No	The resource category ID.	rc-000***123
ResourceRegionId	string	No	The ID of the resource's region. If you omit this parameter, the API returns resources from all regions.	cn-shanghai
ProductType	string	No	The product type of the resource. If you omit this parameter, the API returns resources of all product types. For example, specify `oss` to query resources from Object Storage Service.	oss
ResourceOwnerIds	array	No	A list of resource owner IDs for cross-account resource queries. If you omit this parameter, the API returns resources from the current account.	[123***7890]
	integer	No	The resource owner ID.	123***7890

Response elements

Element	Type	Description	Example
	object	BaseResponse<ListResult>
Data	object	The returned data.
Content	array<object>	A list of cloud products and their data protection status.
	array<object>
ProductType	string	The cloud product type, such as `ECS` and `OSS`.	oss
EnableCheck	boolean	Indicates whether the data protection score is enabled for the cloud product.	true
ProtectionScore	integer	The data protection score, ranging from 0 to 100.	90
ProtectionScoreUpdatedTime	integer	The UNIX timestamp of the last data protection score update.	1726036498
TotalResourceCount	integer	The total count of resources for the cloud product.	100
RiskyResourceCount	integer	The count of risky resources.	1
CheckFailedResourceCount	integer	The count of resources that failed the check.	1
DisableCheckResourceCount	integer	The count of resources for which the check is disabled.	1
WaitForCheckResourceCount	integer	The count of resources pending a check.	1
RiskCount	integer	The count of risky check items.	1
CheckFailedCount	integer	The count of failed check items.	1
ProtectionScoreDistribution	array<object>	The distribution of resources across different score ranges.
	array<object>
Range	object	The score range.
From	integer	The lower bound of the score range, inclusive.	0
To	integer	The upper bound of the score range, inclusive.	60
Count	integer	The count of resources within this score range.	5
NextToken	string	The token for the next page of results. If this parameter is absent from the response, all results have been retrieved.	b4fd3cffcacafd65e3818a0b9b2ff9a2
MaxResults	integer	The maximum number of entries returned per page.	10
TotalCount	integer	The total number of entries that match the query. This parameter is not returned by default.	50
RequestId	string	The request ID.	30FB202A-1D22-5394-AB02-4477CDFCF51F

Examples

Success response

JSON format

{
  "Data": {
    "Content": [
      {
        "ProductType": "oss",
        "EnableCheck": true,
        "ProtectionScore": 90,
        "ProtectionScoreUpdatedTime": 1726036498,
        "TotalResourceCount": 100,
        "RiskyResourceCount": 1,
        "CheckFailedResourceCount": 1,
        "DisableCheckResourceCount": 1,
        "WaitForCheckResourceCount": 1,
        "RiskCount": 1,
        "CheckFailedCount": 1,
        "ProtectionScoreDistribution": [
          {
            "Range": {
              "From": 0,
              "To": 60
            },
            "Count": 5
          }
        ]
      }
    ],
    "NextToken": "b4fd3cffcacafd65e3818a0b9b2ff9a2",
    "MaxResults": 10,
    "TotalCount": 50
  },
  "RequestId": "30FB202A-1D22-5394-AB02-4477CDFCF51F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.