Domain name for API request: csip.intl.tencentcloudapi.com.
This API is used to list database assets.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDbAssets. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| MemberId.N | No | Array of String | Group Account Member ID |
| Filter | No | Filter | Filter parameters |
| AssetTypes.N | No | Array of String | Asset types. Values: MYSQL/MARIADB/REDIS/MONGODB/POSTGRES/CTS/ES/KAFKA/COS/CBS/CFS |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total number. |
| Data | Array of DBAssetVO | Total number of assets |
| RegionList | Array of FilterDataObject | Region Enumeration |
| AssetTypeList | Array of FilterDataObject | Asset Type Enumeration |
| VpcList | Array of FilterDataObject | VPC Enumeration |
| AppIdList | Array of FilterDataObject | Appid Enumeration |
| PublicPrivateAttr | Array of FilterDataObject | Public network private network enumeration |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the list of all database assets.
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDbAssets
<Common request parameters>
{
"Filter": {
"Filters": [
{
"Name": "Status",
"Values": [
"1"
],
"OperatorType": 7
},
{
"Name": "TimeRange",
"Values": [
"2"
],
"OperatorType": 7
}
],
"Limit": 10,
"Offset": 0,
"Order": "desc",
"By": "AssetCreateTime"
},
"MemberId": [
"mem-625225cc0913c901"
]
}
{
"Response": {
"AppIdList": [
{
"Text": "130215132961",
"Value": "130215132961"
}
],
"AssetTypeList": [
{
"Text": "MySQL",
"Value": "MYSQL"
},
{
"Text": "PostgreSQL",
"Value": "POSTGRES"
},
{
"Text": "MariaDB",
"Value": "MARIADB"
}
],
"Data": [
{
"AssetId": "postgres-n3rvf26b",
"AssetType": "POSTGRES",
"Region": "ap-guangzhou",
"VpcName": "li-delete after usage completed"
"ConfigurationRisk": 1,
"AssetName": "Unnamed",
"VpcId": "vpc-ewf1aiej",
"Domain": "example.foo2.com",
"AssetCreateTime": "2024-01-30 16:17:21",
"LastScanTime": "2024-10-30 05:02:29",
"Attack": 0,
"Access": 0,
"ScanTask": 28,
"AppId": 130215132961,
"Uin": "10001459297899",
"NickName": "Melon Oolong 2"
"Port": 0,
"Tag": [
{
"Name": "new",
"Value": "sign"
},
{
"Name": "Business Test",
"Value": "Business test data"
}
],
"PrivateIp": "192.168.222.101:5432",
"PublicIp": "1.1.1.1",
"Status": 1,
"IsCore": 2,
"IsNewAsset": 0
},
{
"AssetId": "tdsql-kfbdnfy9",
"AssetType": "MARIADB",
"Region": "ap-guangzhou",
"VpcName": "li-delete after usage completed"
"ConfigurationRisk": 1,
"AssetName": "tdsql-kfbdnfy9",
"VpcId": "vpc-ewf1aiej",
"Domain": "example.foo.com",
"AssetCreateTime": "2024-01-30 16:12:58",
"LastScanTime": "2024-10-30 05:02:29",
"Attack": 0,
"Access": 0,
"ScanTask": 28,
"AppId": 130215132961,
"Uin": "10001459297899",
"NickName": "Melon Oolong 2"
"Port": 0,
"Tag": [
{
"Name": "new",
"Value": "sign"
}
],
"PrivateIp": "192.168.222.104:3306",
"PublicIp": "1.1.1.1",
"Status": 1,
"IsCore": 2,
"IsNewAsset": 0
},
{
"AssetId": "cdb-4dckmpb7",
"AssetType": "MYSQL",
"Region": "ap-guangzhou",
"VpcName": "li-delete after usage completed"
"ConfigurationRisk": 5,
"AssetName": "cdb419972",
"VpcId": "vpc-ewf1aiej",
"Domain": "example.foo1.com",
"AssetCreateTime": "2024-01-30 15:45:08",
"LastScanTime": "2024-10-30 05:02:29",
"Attack": 0,
"Access": 0,
"ScanTask": 28,
"AppId": 130215132961,
"Uin": "10001459297899",
"NickName": "Melon Oolong 2"
"Port": 0,
"Tag": [
{
"Name": "new",
"Value": "sign"
}
],
"PrivateIp": "192.168.222.103:3306",
"PublicIp": "1.1.1.1",
"Status": 1,
"IsCore": 2,
"IsNewAsset": 0
}
],
"PublicPrivateAttr": [
{
Private Network Service
"Value": "0"
},
{
public network service
"Value": "1"
}
],
"RegionList": [
{
"Text": "Guangzhou"
"Value": "ap-guangzhou"
}
],
"RequestId": "1eca062f-ccb9-44c4-b43c-eda42b62607e",
"Total": 3,
"VpcList": [
{
"Text": "Default-VPC",
"Value": "vpc-ommo5hlv"
},
{
li-usage completed delete
"Value": "vpc-ewf1aiej"
},
{
"Text": "fengqqian2",
"Value": "vpc-fw2ndu5f"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
피드백