All Products
Search
Document Center

Security Center:DescribeExposedStatisticsDetail

Last Updated:Nov 25, 2024

Queries the gateway assets, ports, system components, or public IP addresses that are exposed on the Internet.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeExposedStatisticsDetaillist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
CurrentPageintegerNo

The number of the page to return.

1
StatisticsTypestringYes

The type of the exposed asset. Valid values:

  • exposureType: gateway assets
  • exposurePort: ports
  • exposureComponent: system components
  • exposureIp: IP addresses
exposureType
StatisticsTypeInstanceValuestringNo

The ID of the gateway asset. This parameter is required when the StatisticsType parameter is set to exposureType.

lb-2ze4rso39h4nczcqs****
StatisticsTypeGatewayTypestringNo

The type of the gateway asset. This parameter is required when the StatisticsType parameter is set to exposureType. Valid values:

  • SLB: the public IP address of a Server Load Balancer (SLB) instance
  • DNAT: the NAT gateway that connects to the Internet by using the DNAT feature
SLB
ResourceDirectoryAccountIdlongNo

The Alibaba Cloud account ID of the member in the resource directory.

Note You can call the DescribeMonitorAccounts operation to obtain the ID.
127608589417****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

7CBAFB3F-1ED7-4A23-986A-6F67F0466BD1
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

2
Countinteger

The number of entries returned on the current page.

2
StatisticsDetailsarray<object>

An array consisting of the gateway assets, ports, system components, or public IP addresses that are exposed on the Internet and are returned.

StatisticsDetailobject
ExposureIpstring

The public IP address that is exposed on the Internet.

123.57.XX.XX
ExposurePortstring

The port that is exposed on the Internet.

22
ExposureTypeInstanceNamestring

The name of the gateway asset that is exposed on the Internet.

ngw-bp1vkbju8f3w87c9v****
ExposedCountinteger

The total number of system vulnerabilities that are detected on your server and are exposed on the Internet.

0
ExposureTypestring

The resource from which the asset is exposed. Valid values:

  • INTERNET_IP: the IP address of the Elastic Compute Service (ECS) instance
  • SLB: the public IP address of the SLB instance
  • EIP: the elastic IP address (EIP)
  • DNAT: the NAT gateway that connects to the Internet by using the DNAT feature
SLB
RegionIdstring

The region ID of the asset.

cn-hangzhou
ExposureComponentstring

The system component that is exposed on the Internet.

tomcat
ExposureTypeIdstring

The ID of the instance to which the resource belongs. The valid values of this parameter vary based on the value of the ExposureType parameter.

  • If the value of the ExposureType parameter is INTERNET_IP, the value of this parameter is an empty string.
  • If the value of the ExposureType parameter is SLB, the value of this parameter is the ID of the Internet-facing SLB instance.
  • If the value of the ExposureType parameter is EIP, the value of this parameter is the ID of the EIP.
  • If the value of the ExposureType parameter is DNAT, the value of this parameter is the ID of the NAT gateway.
lb-2ze4rso39h4nczcqs****

Examples

Sample success responses

JSONformat

{
  "RequestId": "7CBAFB3F-1ED7-4A23-986A-6F67F0466BD1",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "StatisticsDetails": [
    {
      "ExposureIp": "123.57.XX.XX",
      "ExposurePort": "22",
      "ExposureTypeInstanceName": "ngw-bp1vkbju8f3w87c9v****",
      "ExposedCount": 0,
      "ExposureType": "SLB",
      "RegionId": "cn-hangzhou",
      "ExposureComponent": "tomcat",
      "ExposureTypeId": "lb-2ze4rso39h4nczcqs****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400RdCheckNoPermissionResource directory account verification has no permission.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500RdCheckInnerErrorResource directory account service internal error.-
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-02-28The Error code has changed. The request parameters of the API has changedView Change Details
2022-12-23API Description Update. The API operation is not deprecated.View Change Details