All Products
Search
Document Center

Security Center:DescribeExposedInstanceList

Last Updated:Nov 25, 2024

Queries the information about the assets 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:DescribeExposedInstanceListget
*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
GroupIdlongNo

The ID of the server group.

Note You can call the DescribeAllGroups operation to query the IDs of server groups.
9535356
VulStatusbooleanNo

Specifies whether the asset has vulnerabilities. Valid values:

  • true
  • false
true
HealthStatusbooleanNo

Specifies whether the asset has weak password risks. Valid values:

  • true
  • false
Unhealthy
ExposureComponentstringNo

The server component that is exposed on the Internet.

openssl
ExposurePortstringNo

The port that is exposed on the Internet.

22
ExposureIpstringNo

The public IP address of the server or the public endpoint of the database.

116.12.XX.XX
InstanceIdstringNo

The instance ID of the asset.

i-bp1g6wxdwps7s9dz****
InstanceNamestringNo

The name of the asset.

abc_centos7.2_005
ResourceDirectoryAccountIdlongNo

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

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

The type of the asset. Valid values:

  • 0: an Elastic Compute Service (ECS) instance.
  • 3: an ApsaraDB RDS instance.
  • 4: an ApsaraDB for MongoDB instance.
  • 5: an ApsaraDB for Redis instance.
0
CspmStatusbooleanNo

Specifies whether the asset has Cloud Security Posture Management (CSPM) risks. Valid values:

  • true
  • false
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

598A4A61-ABA7-456B-8725-7378258276D9
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
ExposedInstancesarray<object>

The details of the exposures.

ExposedInstanceobject
ExposureIpstring

The public IP address that is exposed on the Internet.

116.12.XX.XX
TotalVulCountinteger

The total number of vulnerabilities that are exposed on the Internet and can be exploited by attackers.

0
InternetIpstring

The public IP address of the server.

116.12.XX.XX
NntfVulCountinteger

The number of low-severity vulnerabilities that are exposed on the Internet and can be exploited by attackers.

0
InstanceIdstring

The instance ID of the asset.

i-bp1g6wxdwps7s9dz****
ExposureTypestring

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

  • INTERNET_IP: the public IP address of an ECS instance.
  • SLB: the public IP address of a Server Load Balancer (SLB) instance.
  • EIP: an elastic IP address (EIP).
  • DNAT: the NAT gateway that connects to the Internet by using the Destination Network Address Translation (DNAT) feature.
  • DB_CONNECTION: the public endpoint of a database.
INTERNET_IP
IntranetIpstring

The private IP address of the server.

192.168.XX.XX
RegionIdstring

The ID of the region in which the asset resides.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
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, this parameter is empty.
  • If the value of the ExposureType parameter is SLB, the value of this parameter is the ID of the 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.
  • If the value of the ExposureType parameter is DB_CONNECTION, the value of this parameter is the ID of the database.
i-ew11313a****
AsapVulCountinteger

The number of high-severity vulnerabilities that are exposed on the Internet and can be exploited by attackers.

0
ExposurePortstring

The port that is exposed on the Internet.

22
Uuidstring

The UUID of the server or the instance ID of the cloud service.

dd803d9e-a337-4add-9c5b-7d503e08****
GroupNamestring

The name of the server group.

testGroup
GroupIdlong

The ID of the server group.

9469268
ExploitHealthCountinteger

The number of weak password risks.

0
InstanceNamestring

The name of the asset.

abc_centos7.2_005
ExposureComponentstring

The server component that is exposed on the Internet.

openssl,openssh
LaterVulCountinteger

The number of medium-severity vulnerabilities that are exposed on the Internet and can be exploited by attackers.

0
CspmAlarmCountinteger

The number of CSPM risks.

0
AssetTypeinteger

The type of the asset. Valid values:

  • 0: an ECS instance.
  • 1: a SLB instance.
  • 2: a NAT gateway.
  • 3: an ApsaraDB RDS instance.
  • 4: an ApsaraDB for MongoDB instance.
  • 5: an ApsaraDB for Redis instance.
  • 6: a container image.
  • 7: a container.
0
CloudAssetInfostring

The JSON string that specifies the information about a database asset, which contains the following fields.

  • assetSubType: the asset subtype.
  • assetSubTypeName: the name of the asset subtype.
  • assetType: the type of the asset.
  • assetTypeName: the name of the asset type.
  • vendor: the service provider of the asset.
{assetSubTypeName":"INSTANCE","assetType":3,"assetTypeName":"RDS","vendor":0}

Examples

Sample success responses

JSONformat

{
  "RequestId": "598A4A61-ABA7-456B-8725-7378258276D9",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "ExposedInstances": [
    {
      "ExposureIp": "116.12.XX.XX",
      "TotalVulCount": 0,
      "InternetIp": "116.12.XX.XX",
      "NntfVulCount": 0,
      "InstanceId": "i-bp1g6wxdwps7s9dz****",
      "ExposureType": "INTERNET_IP",
      "IntranetIp": "192.168.XX.XX",
      "RegionId": "cn-hangzhou",
      "ExposureTypeId": "i-ew11313a****",
      "AsapVulCount": 0,
      "ExposurePort": "22",
      "Uuid": "dd803d9e-a337-4add-9c5b-7d503e08****",
      "GroupName": "testGroup",
      "GroupId": 9469268,
      "ExploitHealthCount": 0,
      "InstanceName": "abc_centos7.2_005",
      "ExposureComponent": "openssl,openssh",
      "LaterVulCount": 0,
      "CspmAlarmCount": 0,
      "AssetType": 0,
      "CloudAssetInfo": "{assetSubTypeName\":\"INSTANCE\",\"assetType\":3,\"assetTypeName\":\"RDS\",\"vendor\":0}"
    }
  ]
}

Error codes

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

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

Change history

Change timeSummary of changesOperation
2024-09-26The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
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.. The Error code has changedView Change Details