すべてのプロダクト
Search

このプロダクト

    Web Application Firewall:DescribeApisecApiResources

    ドキュメントセンター

    Web Application Firewall:DescribeApisecApiResources

    最終更新日:Jul 07, 2026

    API セキュリティ資産のリストを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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
    PageSize

    integer

    任意

    ページングクエリで各ページに返されるエントリ数。デフォルト値: 10 で、各ページに 10 件のエントリが含まれることを示します。

    10
    Follow

    integer

    任意

    API がフォローされているかどうかを指定します。有効な値:

    • 1: フォロー中。

    • 0: フォローしていない。

    0
    ApiType

    string

    任意

    サービスオブジェクト。有効な値:

    • PublicAPI: パブリックサービス。

    • ThirdpartAPI: サードパーティ連携。

    • InternalAPI: 社内利用。

    innerAPI
    ApiTag

    string

    任意

    API の業務目的。

    説明

    DescribeApisecRules を呼び出して、サポートされている業務目的を取得できます。

    SendMail
    SensitiveLevel

    string

    任意

    API の感度レベル。有効な値:

    • 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

    任意

    API に認証フィールドがあるかどうかを指定します。有効な値:

    • 0: 認証あり。

    • 1: 認証なし。

    0
    RegionId

    string

    任意

    WAF インスタンスがデプロイされているリージョン。有効な値:

    • cn-hangzhou: 中国本土。

    • ap-southeast-1: 中国本土以外。

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    任意

    Alibaba Cloud リソースグループ 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

    API に認証フィールドがあるかどうかを指定します。有効な値:

    • 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

    API がフォローされているかどうかを指定します。有効な値:

    • 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

    例

    成功レスポンス

    JSONJSON

    {
  "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
    }
  ]
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。