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	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	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[FilterOptionAiBill]	Resource option list	Yes
Models	array[FilterOptionAiBill]	Model option list	No
Dimensions	array[FilterOptionAiBill]	Billing dimension option list	No
PricingUnits	array[FilterOptionAiBill]	Pricing unit option list	No
Regions	array[FilterOptionAiBill]	Region option list	No
ProductCodes	array[FilterOptionAiBill]	Product code option list	No
Projects	array[FilterOptionAiBill]	Project option list	No
PricingSKUs	array[FilterOptionAiBill]	Billing SKU option list	No

Data Model

FilterOptionAiBill

Field Name	Type	Description Information	Required
Name	string	name	No
Value	object	value	No

Example

Request Example


https://api.surfercloud.com/?Action=GetFilterOptions
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=KOvuFbMW
&ProductCode=rjAIcPrn

Response Example


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