GetGovernanceItemReport-阿里云帮助中心

Queries the details of a specific check item in an identity and access governance report.

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

ram:GetGovernanceItemReport

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GovernanceItemType	string	No	The check item. For more information, see Identity and access governance check items.	SSOLoginEnabled
Marker	string	No	If the response is truncated, use the `Marker` to retrieve the subsequent content.	EXAMPLE
MaxItems	string	No	The number of entries to return. If the response is truncated because the number of entries exceeds the value of `MaxItems`, the value of the `IsTruncated` parameter is true. Valid values: 1 to 1000. Default value: 1000.	1000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F2CE9688-AA85-5F23-8C22-0EC23473405F
GenerateTime	string	The time when the report for the check item was generated.	2020-10-19T15:06:52Z
MetricType	string	The data type of the metric value. Valid values: Number: the numeric type. String: the string type. Boolean: the Boolean type.	Number
MetricValue	any	The metric value.	100
ColumnsSchema	object
ColumnSchema	array<object>	The schema of the detail columns. This is an array, and its length is the number of columns.
	object	The schema of a single detail column.
ColumnName	string	The column name.	UserPrincipalName
ColumnType	string	The column type. Valid values: Number: the numeric type. String: the string type. Boolean: the Boolean type.	String
ColumnsValue	object
ColumnRow	array<object>	The detailed values, which are a two-dimensional array. Each row has a fixed length. The data type, value, length, and order of values in each row are consistent with the schema described in ColumnsSchema.
	object
ColumnValue	array	A row of detailed values.
	any	The data object in this row.	test@example.onaliyun.com
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true false	true
Marker	string	This parameter is returned only when `IsTruncated` is set to true. Use this parameter to retrieve the truncated content.	EXAMPLE

Examples

Success response

JSON format

{
  "RequestId": "F2CE9688-AA85-5F23-8C22-0EC23473405F",
  "GenerateTime": "2020-10-19T15:06:52Z",
  "MetricType": "Number",
  "MetricValue": "100",
  "ColumnsSchema": {
    "ColumnSchema": [
      {
        "ColumnName": "UserPrincipalName",
        "ColumnType": "String"
      }
    ]
  },
  "ColumnsValue": {
    "ColumnRow": [
      {
        "ColumnValue": [
          "test@example.onaliyun.com"
        ]
      }
    ]
  },
  "IsTruncated": true,
  "Marker": "EXAMPLE"
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.