Updated on 2026-07-22 GMT+08:00

Listing the Specified Analyzer

Function

This API is used to retrieve information about the specified analyzer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

AccessAnalyzer:analyzer:get

Read

analyzer *

g:ResourceTag/<tag-key>

-

-

URI

GET /v5/analyzers/{analyzer_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

analyzer_id

Yes

String

Definition:

Unique identifier of an analyzer.

You can call the ListAnalyzers API to obtain the analyzer ID. The response parameters of this API return an analyzer list. The id field of each analyzer object is the analyzer ID.

Range:

1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

analyzer

AnalyzerSummary object

Definition:

Information about an analyzer.

Range:

N/A

Table 3 AnalyzerSummary

Parameter

Type

Description

configuration

AnalyzerConfiguration object

Definition:

Configuration items of the analyzer.

Range:

N/A

created_at

String

Definition:

Time when the analyzer was created. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z.

Range:

N/A

id

String

Definition:

Unique identifier of an analyzer.

Range:

1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

last_analyzed_resource

String

Definition:

Unique resource identifier of the resource that was analyzed last time.

Range:

N/A

last_resource_analyzed_at

String

Definition:

Last time when resources were analyzed. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z.

Range:

N/A

last_all_analyzed_at

String

Definition:

Last time when all resources were analyzed. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z.

Range:

N/A

name

String

Definition:

Analyzer name.

Range:

1 to 255 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

organization_id

String

Definition:

Organization ID.

Range:

The value contains 1 to 35 characters. The value must start with ou- followed by 8 to 32 lowercase letters or digits.

status

String

Definition:

Status of an access analyzer.

Range:

  • active: activated

  • creating: being created

  • disabled: disabled

  • failed: creation failed

status_reason

StatusReason object

Definition:

More details about the current status of the analyzer.

Range:

N/A

tags

Array of Tag objects

Definition:

List of custom tags.

Range:

Array length: 1 to 20.

type

String

Definition:

Analyzer type.

Range:

  • account: account-level external access analyzer

  • organization: organization-level external access analyzer

  • account_unused_access: account-level unused access analyzer

  • organization_unused_access: organization-level unused access analyzer

  • account_privilege_escalation: account-level privilege escalation access analyzer

  • account_iam_best_practice: account-level IAM best practice analyzer

urn

String

Definition:

Unique resource identifier of an analyzer.

Range:

The value can contain up to 1,500 characters.

Table 4 AnalyzerConfiguration

Parameter

Type

Description

unused_access

unused_access object

Definition:

Configuration items of unused access analyzers.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 5 unused_access

Parameter

Type

Description

unused_access_age

Integer

Definition:

Preset number of days for generating findings.

Constraints:

N/A

Range:

The value ranges from 1 to 180.

Default Value:

90.

unused_analysis_rule

UnusedAnalysisRule object

Definition:

Unused analysis rule.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 6 UnusedAnalysisRule

Parameter

Type

Description

exclusions

Array of UnusedAnalysisRuleCriteria objects

Definition:

Exclusion rule.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 7 UnusedAnalysisRuleCriteria

Parameter

Type

Description

account_ids

Array of strings

Definition:

List of organization account IDs. This parameter is optional when you create an unused access analyzer at the organization level. The specified accounts will not generate analysis findings.

To view the list of your organization account IDs on the Huawei Cloud console, perform the following steps:

  1. Log in to the Huawei Cloud console.

  2. Open the service list in the upper left corner of the page and choose Organizations.

  3. Click account management on the left to view the account ID list of the organization.

Constraints:

N/A

Range:

The array length ranges from 1 to 2,000. The array elements contain 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Default Value:

N/A

resource_tags

Array of Tag objects

Definition:

List of resource tags.

Constraints:

N/A

Range:

Array length: 1 to 20.

Default Value:

N/A

Table 8 StatusReason

Parameter

Type

Description

code

String

Definition:

Reason for the analyzer status.

Range:

  • delegated_administrator_deregistered: The delegated administrator is not registered.

  • trusted_service_disabled: The trusted service is disabled.

  • internal_error: There is an internal error.

  • organization_deleted: The organization has been deleted.

  • service_linked_agency_creation_failed: The service-linked agency fails to be created.

details

String

Definition:

Reason details for the status of the analyzer.

Range:

N/A

Table 9 Tag

Parameter

Type

Description

key

String

Definition:

Tag key.

Constraints:

Cannot start with sys and cannot start or end with a space.

Range:

1 to 128 characters. The value can contain Unicode letters, digits, spaces, and the following special characters: _.:=+-@.

Default Value:

N/A

value

String

Definition:

String value associated with the tag key.

Constraints:

N/A

Range:

0 to 255 characters. The value can contain Unicode letters, digits, spaces, and the following special characters: _.:/=+-@.

Default Value:

N/A

Example Requests

Retrieving information about the specified analyzer.

GET https://{hostname}/v5/analyzers/{analyzer_id}

Example Responses

Status code: 200

OK

{
  "analyzer" : {
    "created_at" : "2023-09-07T07:51:10.502Z",
    "id" : "{analyzer_id}",
    "last_analyzed_resource" : "iam::{domain_id}:agency:{agency_name}",
    "last_resource_analyzed_at" : "2023-09-07T07:51:10.502Z",
    "name" : "my-analyzer",
    "status" : "active",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    } ],
    "type" : "account",
    "urn" : "AccessAnalyzer:{region_id}:{domain_id}:analyzer:{analyzer_id}"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.