調用DescribeApisecApiResources查詢API安全資產列表-Web Application Firewall-阿里雲 - Web Application Firewall

查詢 API 安全資產列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeApisecApiResources

get

*All Resource

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體的 ID。說明您可以呼叫 DescribeInstance 取得目前 WAF 執行個體的 ID。	waf_v2_public_cn-u***gr20j
ApiId	string	否	API 的 ID。	867ade***24ee6e205b8da82b8f84
ApiFormat	string	否	API 介面。	/auth/login
MatchedHost	string	否	API 介面所屬的網域或 IP。	a.aliyun.com
SensitiveType	string	否	回應敏感資料類型。說明您可以呼叫 DescribeApisecRules 取得支援的敏感資料類型。	1004
ApiStatus	string	否	API 的狀態。取值： NewbornInterface：表示新增。 OfflineInterface：表示失活。 normal：表示正常。	OfflineInterface
StartTime	string	否	查詢的開始時間，格式為 Unix 時間戳記（UTC 時間），單位為秒。	1681833600
EndTime	string	否	查詢的結束時間，格式為 Unix 時間戳記（UTC 時間），單位為秒。	1683388800
OrderKey	string	否	排序欄位的名稱。取值： allCnt：表示近 30 天總存取量。 botCnt：表示近 30 天機器存取量。 crossBorderCnt：表示近 30 天跨境存取量。 abnormalNum：表示 API 關聯風險數量。 eventNum：表示 API 關聯事件數量。 farthestTs：表示首次發現時間。 lastestTs：表示最近存取時間。	allCnt
OrderWay	string	否	排序的方式。取值： desc：表示降序（預設）。 asc：表示升序。	desc
PageNumber	integer	否	分頁查詢時，返回第幾頁資料。預設值為 1，表示返回第 1 頁資料。	1
PageSize	integer	否	分頁查詢時，每頁包含多少筆結果。預設值為 10，表示每頁包含 10 筆結果。	10
Follow	integer	否	是否關注。取值： 1：表示關注。 0：表示未關注。	0
ApiType	string	否	服務物件。取值： PublicAPI：表示公共服務。 ThirdpartAPI：表示第三方合作。 InternalAPI：表示內部辦公。	innerAPI
ApiTag	string	否	API 業務用途。說明您可以呼叫 DescribeApisecRules 取得支援的業務用途。	SendMail
SensitiveLevel	string	否	介面敏感等級。取值： L1：表示高敏感。 L2：表示中敏感。 L3：表示低敏感。 N：表示非敏感。	L3
ApiMethod	string	否	API 的請求方法。取值： GET：表示 GET 請求。 POST：表示 POST 請求。 HEAD：表示 HEAD 請求。 PUT：表示 PUT 請求。 DELETE：表示 DELETE 請求。 CONNECT：表示 CONNECT 請求。 PATCH：表示 PATCH 請求。 OPTIONS：表示 OPTIONS 請求。	POST
ClusterId	string	否	混合雲叢集 ID。說明僅針對混合雲情境，您可以呼叫 DescribeHybridCloudClusters 取得混合雲叢集資訊。	740
Note	string	否	備註資訊。	loginApi
RequestSensitiveType	string	否	請求敏感資訊類型。說明您可以呼叫 DescribeApisecRules 取得支援的敏感資訊類型。	1004,1005
AuthFlag	string	否	是否有驗證欄位。取值： 0：表示有權限。 1：表示無權限。	0
RegionId	string	否	WAF 執行個體所屬地域。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q

返回參數

名稱	類型	描述	樣本值
	object	請求結果。
TotalCount	integer	返回結果的總數。	5
RequestId	string	請求 ID。	2EFCFE18-78F8-5079-B312-07***48B
Data	array<object>	API 資產列表。
	object	資產詳情。
EventNum	integer	API 關聯的安全事件數量。	2
FarthestTs	integer	API 資產首次發現時間，格式為 Unix 時間戳記（UTC 時間），單位為秒。	1683388800
ApiSensitive	string	API 涉及的敏感資訊，以一系列參數構造的 JSON 格式轉化成字串。包括： request_sensitive_list：表示請求敏感資料類型列表。 response_sensitive_list：表示回應敏感資料類型列表。 sensitive_list：表示敏感資料類型列表。 sensitive_level：表示敏感等級。	{ "sensitive_list": ["1003","1005"], "sensitive_level": "L2", "request_sensitive_list": ["1003"], "response_sensitive_list": ["1005"] }
ApiFormat	string	API 介面。	/v1/etl/finddatabyvid
ApiTag	string	API 業務用途。說明您可以呼叫 DescribeApisecRules 取得支援的業務用途。	SendMail
CrossBorderCnt	integer	近 30 天跨境存取量。	2
AuthFlag	string	是否有驗證欄位。取值： 0：表示有權限。 1：表示無權限。	1
AllCnt	integer	近 30 天總存取量。	1683388800
ApiMethod	string	API 的請求方法。取值： GET：表示 GET 請求。 POST：表示 POST 請求。 HEAD：表示 HEAD 請求。 PUT：表示 PUT 請求。 DELETE：表示 DELETE 請求。 CONNECT：表示 CONNECT 請求。 PATCH：表示 PATCH 請求。 OPTIONS：表示 OPTIONS 請求。	POST
LastestTs	integer	API 資產最近存取時間，格式為 Unix 時間戳記（UTC 時間），單位為秒。	1683388800
ApiStatus	string	API 的狀態。取值： NewbornInterface：表示新增。 OfflineInterface：表示失活。 normal：表示正常。	NewbornInterface
ApiSensitiveResponse	string	API 回應敏感資料。	["1002","1005"]
BotCnt	integer	近 30 天機器存取量。	2
Follow	integer	是否關注。取值： 1：表示關注。 0：表示未關注。	1
MatchedHost	string	API 介面所屬的網域或 IP。	a.aliyun.com
ApiInfo	string	API 相關資訊，以一系列參數構造的 JSON 格式轉化成字串。包括： param_num：表示 API 參數數量。 request_method：表示請求方式。 protocol：表示請求協定。 api_url：表示請求 URL。 poc_payload：表示請求。 request：表示請求範例。 response：表示回應範例。 param：表示請求參數。說明只有指定入參 ApiId 才會有該返回值。	{ "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: /' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
AbnormalNum	integer	API 關聯的風險數量。	2
ApiType	string	服務物件。取值： PublicAPI：表示公共服務。 ThirdpartAPI：表示第三方合作。 InternalAPI：表示內部辦公。	PublicAPI
Note	string	備註資訊。	loginApi
ApiId	string	API 的 ID。	197b52abcd81d6a8bd4***e477
Examples `deprecated`	array	API 範例列表。
	string	範例資訊，以一系列參數構造的 JSON 格式轉化成字串。包括： param_num：表示 API 參數數量。 request_method：表示請求方式。 protocol：表示請求協定。 api_url：表示請求 URL。 poc_payload：表示請求。 request：表示請求範例。 response：表示回應範例。 param：表示請求參數。說明只有指定入參 ApiId 才會有該返回值。	{ "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: /' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
ApiSensitiveRequest	string	API 請求敏感資料。	["1002","1005"]
Resources	array	資產對應的防護物件列表。
	string	資產對應的防護物件。	***.top-waf
AccountEventNum	integer	資產關聯的帳號安全事件數量。	1

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 5,
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "Data": [
    {
      "EventNum": 2,
      "FarthestTs": 1683388800,
      "ApiSensitive": "{\n    \"sensitive_list\": [\"1003\",\"1005\"],\n    \"sensitive_level\": \"L2\",\n    \"request_sensitive_list\": [\"1003\"],\n    \"response_sensitive_list\": [\"1005\"]\n}",
      "ApiFormat": "/v1/etl/finddatabyvid",
      "ApiTag": "SendMail",
      "CrossBorderCnt": 2,
      "AuthFlag": "1",
      "AllCnt": 1683388800,
      "ApiMethod": "POST",
      "LastestTs": 1683388800,
      "ApiStatus": "NewbornInterface",
      "ApiSensitiveResponse": "[\"1002\",\"1005\"]",
      "BotCnt": 2,
      "Follow": 1,
      "MatchedHost": "a.aliyun.com",
      "ApiInfo": "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}",
      "AbnormalNum": 2,
      "ApiType": "PublicAPI",
      "Note": "loginApi",
      "ApiId": "197b52abcd81d6a8bd4***e477",
      "Examples": [
        "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}"
      ],
      "ApiSensitiveRequest": "[\"1002\",\"1005\"]",
      "Resources": [
        "***.top-waf"
      ],
      "AccountEventNum": 1
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。