All Products
Search
Document Center

Smart Access Gateway:ListDpiSignatures

Last Updated:Mar 03, 2024

Queries the information about an application or an application group in a region, or about the applications supported by Smart Access Gateway (SAG) in a region.

Operation description

This operation supports the following features:

  • Queries the information about all applications supported by the SAG instance in a specified region.
  • Queries the information about an application by application ID in a specified region.
  • Queries the information about an application by application name in a specified region.
  • Queries the information about an application group by group ID in a specified region.

If this is the first time you call this operation, we recommend that you query all applications supported by the SAG instance in the specified region by region ID. Then, you can query the information about a specified application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the application or application group belongs.

You can call the DescribeRegions operation to query the most recent region list.

cn-shanghai
NextTokenstringNo

The token used to query the next page.

caeba0bbb2****
MaxResultsintegerNo

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 20.

20
DpiGroupIdstringNo

The ID of the application group.

20
DpiSignatureIdsarrayNo
stringNo

The ID of the application.

235
DpiSignatureNamesarrayNo
stringNo

The name of the application.

EdgeCast

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned on the current page.

1
NextTokenstring

The token returned for the next query.

FFrMV38kR4****
RequestIdstring

The ID of the request.

63081123-B7C0-4BC9-B9E5-59E77A616EC9
DpiSignatureobject []

The information about the application.

DpiSignatureIdstring

The ID of the application.

235
MinSignatureDbVersionstring

The earliest version of signature database that supports the application.

20201117_1_0-0.0.1
DpiGroupIdstring

The ID of the application group to which the application belongs.

20
MinEngineVersionstring

The earliest version of engine that supports the application.

0-0.0.1
DpiSignatureNamestring

The name of the application.

EdgeCast

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "NextToken": "FFrMV38kR4****",
  "RequestId": "63081123-B7C0-4BC9-B9E5-59E77A616EC9",
  "DpiSignature": [
    {
      "DpiSignatureId": "235",
      "MinSignatureDbVersion": "20201117_1_0-0.0.1",
      "DpiGroupId": "20",
      "MinEngineVersion": "0-0.0.1",
      "DpiSignatureName": "EdgeCast"
    }
  ]
}

Error codes

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