# Get Filter Options - GetFilterOptions

## Overview

Query available filter options including resources, models, and regions for order filtering






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetFilterOptions`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.sigcalcloud.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProductCode** | string | Product code filter (single value, optional). Enum: `modelverse`, `sandbox`. Returns options for all products if empty |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **ResourceIds** | array[[*FilterOptionString*](#filteroptionstring)] | Resource option list |**Yes**|
| **Models** | array[[*FilterOptionString*](#filteroptionstring)] | Model option list |No|
| **Dimensions** | array[[*FilterOptionString*](#filteroptionstring)] | Billing dimension option list |No|
| **PricingUnits** | array[[*FilterOptionInteger*](#filteroptioninteger)] | Pricing unit option list |No|
| **Regions** | array[[*FilterOptionString*](#filteroptionstring)] | Region option list |No|
| **ProductCodes** | array[[*FilterOptionString*](#filteroptionstring)] | Product code option list |No|
| **Projects** | array[[*FilterOptionInteger*](#filteroptioninteger)] | Project option list |No|
| **PricingSKUs** | array[[*FilterOptionString*](#filteroptionstring)] | Billing SKU option list |No|
| **OrderTypes** | array[[*FilterOptionInteger*](#filteroptioninteger)] | Order type option list |No|

#### Data Model


#### FilterOptionString

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | Name |No|
| **Value** | string | Value |No|

#### FilterOptionInteger

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | Name |No|
| **Value** | int | Value |No|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=GetFilterOptions
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=KOvuFbMW
&ProductCode=rjAIcPrn
```

### Response Example
    
```json
{
  "Action": "GetFilterOptionsResponse",
  "Data": {},
  "Dimensions": [
    {
      "Name": "XtBSHSoJ",
      "Value": "WgZmMQOo"
    }
  ],
  "Models": [
    {
      "Name": "kqJMJdxD",
      "Value": "gxiRtfIw"
    }
  ],
  "OrderTypes": [
    {
      "Name": "WftpPgnQ",
      "Value": {}
    }
  ],
  "PricingSKUs": "qgNjqply",
  "PricingUnits": [
    {
      "Name": "MoqIBNBK",
      "Value": "yJfochKY"
    }
  ],
  "ProductCodes": "nmkSUkVh",
  "Projects": "tEWWkBoj",
  "Regions": "nBOVDUOg",
  "RetCode": 0
}
```