Queries the information about the assets that are exposed on the Internet.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
yundun-sas:DescribeExposedInstanceList | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
PageSize | integer | No | 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 |
CurrentPage | integer | No | The number of the page to return. | 1 |
GroupId | long | No | The ID of the server group. Note
You can call the DescribeAllGroups operation to query the IDs of server groups.
| 9535356 |
VulStatus | boolean | No | Specifies whether the asset has vulnerabilities. Valid values:
| true |
HealthStatus | boolean | No | Specifies whether the asset has weak password risks. Valid values:
| Unhealthy |
ExposureComponent | string | No | The server component that is exposed on the Internet. | openssl |
ExposurePort | string | No | The port that is exposed on the Internet. | 22 |
ExposureIp | string | No | The public IP address of the server or the public endpoint of the database. | 116.12.XX.XX |
InstanceId | string | No | The instance ID of the asset. | i-bp1g6wxdwps7s9dz**** |
InstanceName | string | No | The name of the asset. | abc_centos7.2_005 |
ResourceDirectoryAccountId | long | No | The Alibaba Cloud account ID of the member in the resource directory. Note
You can call the DescribeMonitorAccounts operation to obtain the ID.
| 16670360956***** |
AssetType | string | No | The type of the asset. Valid values:
| 0 |
CspmStatus | boolean | No | Specifies whether the asset has Cloud Security Posture Management (CSPM) risks. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | NoPermission | no permission | - |
400 | RdCheckNoPermission | Resource directory account verification has no permission. | - |
403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
500 | ServerError | ServerError | - |
500 | RdCheckInnerError | Resource directory account service internal error. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-09-26 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
2024-02-28 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2022-12-23 | API Description Update. The API operation is not deprecated.. The Error code has changed | View Change Details |