Call the DescribeDBInstanceParameters API to query instance parameters.

Request parameters

Only the request parameters specific to this API and some common parameters are listed below. For more information, see Common parameters.

Action string Example value: DescribeDBInstanceParameters

The action to perform. The value is DescribeDBInstanceParameters.

Version string Example value: 2022-01-01

The API version. The value is 2022-01-01.

InstanceId string Example value: mssql-dab1be87****

Instance ID.

tip

You can call the DescribeDBInstances API to query the instance ID.

ParameterNames string Optional Example value: Agent XPs

Parameter name.

tip

Fuzzy search is supported. If this parameter is not specified, all parameters for the instance are returned.

Response parameters

Only the response parameters specific to this API are listed below. For more information, refer to Return structure.

InstanceId string Example value: mssql-dab1be87****

DBEngine string Example value: Sqlserver

DBEngineVersion string Example value: SQLServer_2019_Std

ParameterCount integer Example value: 1

InstanceParameters object[] Example value: [ { "CheckingCode": "[0~1]", "ForceModify": false, "ForceRestart": false, "ParameterDefaultValue": "1", "ParameterDescription": "The Agent XPs option. This option enables the SQL Server Agent extended stored procedures on this server. If this option is disabled, the SQL Server Agent node is not displayed in the SQL Server Management Studio Object Explorer. ", "ParameterName": "Agent XPs", "ParameterType": "Integer", "ParameterValue": "1" } ]

Request example

POST /?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.cn-beijing.volcengineapi.com​
X-Date: 20230131T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
    "InstanceId": "mssql-dab1be87****",​
    "ParameterNames": "Agent XPs"​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "20230131204425AB5D9AC0AB56989E8790",​
        "Action": "DescribeDBInstanceParameters",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "DBEngine": "Sqlserver",​
        "DBEngineVersion": "SQLServer_2019_Std",​
        "InstanceId": "mssql-dab1be87****",​
        "InstanceParameters": [​
            {​
                "CheckingCode": "[0~1]",​
                "ForceModify": false,​
                "ForceRestart": false,​
                "ParameterDefaultValue": "1",​
                "ParameterDescription": "代理XP选项。使用Agent XPs 选项可以启用此服务器上的 SQL Server 代理扩展存储过程。如果禁用此选项，则SQL Server Management Studio对象资源管理器将不显示 SQL Server 代理节点。",​
                "ParameterName": "Agent XPs",​
                "ParameterType": "Integer",​
                "ParameterValue": "1"​
            }​
        ],​
        "ParameterCount": 1​
    }​
}​

Error code

The following table lists the business logic-related error codes for this API. For common error codes, see the Common Error Codes document.

Status code	Error code	Error message	Description
400	OperationDenied_ImportJobExists	The operation is not permitted due to exist running import job.	This action can not be performed while the current instance is importing data.
400	UserBackupAmountOverTheLimit	The operation is not permitted due to the user backup amount over the limit.	The maximum number of manual backups has been reached.
400	OperationDenied_BackupJobExists	The operation is not permitted due to exist running backup job.	This operation cannot be performed because the instance is currently running a backup task.
400	OperationUnsupported	The operation is unsupported for the specified instance.	Operation not supported.
400	InstanceIsNotRunning	The specified instance is not running.	The current instance is not running.
400	OperationDenied_IncrBackupUnsupportRecovery	The operation is not permitted due to incr backup unsupport recovery.	This operation can not be performed on an incremental backup.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The {parameter1} parameter is missing.
400	InvalidDBName_Duplicate	The specified DBName already exists.	The database already exists.
400	TosRestoreTaskDbVerifyFailed	db verify failed, reason:%s.	DB validation failed due to {parameter1}.
400	InvalidParameter	The specified parameter %s is not valid.	The value for parameter {parameter1} is invalid.
400	InvalidParameterFormat	The input parameter is not valid.	Invalid parameter.
403	QuotaExceeded_RestoreDB	The quota of restore db exceeds.	The quota for database restores has been exceeded.
403	OperationDenied_ResourceSoldOut	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	Insufficient resources in the current availability zone.
404	BackupNotFound	The specified instance does not exist available backup records.	No available backup records found.
404	InstanceNotFound	The specified instance does not exist.	Instance not found.
500	InternalError	The request failed with internal server error.	Internal error.
500	TosRestoreTaskNumExceedLimit	Too many tasks are being executed. Please submit them later.	Too many tasks are running. Please try again later.

RDS for SQL Server