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}
| 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
| Parameter | Type | Description |
|---|---|---|
| analyzer | AnalyzerSummary object | Definition: Information about an analyzer. Range: N/A |
| 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: |
| 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: |
| urn | String | Definition: Unique resource identifier of an analyzer. Range: The value can contain up to 1,500 characters. |
| 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 |
| 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 |
| Parameter | Type | Description |
|---|---|---|
| exclusions | Array of UnusedAnalysisRuleCriteria objects | Definition: Exclusion rule. Constraints: N/A Range: N/A Default Value: N/A |
| 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:
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 |
| Parameter | Type | Description |
|---|---|---|
| code | String | Definition: Reason for the analyzer status. Range: |
| details | String | Definition: Reason details for the status of the analyzer. Range: N/A |
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot