DescribeDBInstanceParameters--云数据库 SQL Server 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceParameters

最近更新时间：2024.01.05 13:55:41首次发布时间：2023.04.24 11:01:04

调用 DescribeDBInstanceParameters 接口查询实例参数。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	mssql-dab1be87****	实例 ID 说明您可以调用 DescribeDBInstances 接口查询实例 ID。
ParameterNames	String	否	Agent XPs	参数名。说明支持模糊查询，不配置此参数时，则返回实例下所有参数。

返回参数

名称	类型	示例值	描述
InstanceId	String	mssql-dab1be87****	实例 ID。
DBEngine	String	Sqlserver	数据库类型。当前数据库类型取值仅支持 `Sqlserver`。
DBEngineVersion	String	SQLServer_2019_Std	兼容版本。取值如下： `SQLServer_2019_Std`：表示 SQL Server 2019 标准版。 `SQLServer_2019_Web`：表示 SQL Server 2019 Web 版。 `SQLServer_2019_Ent`：表示 SQL Server 2019 企业版。
ParameterCount	Integer	1	参数个数。
InstanceParameters	Array of InstanceParametersObject	InstanceParametersObject	该实例当前运行的参数列表。

请求示例

POST /?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.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"
}

返回示例

正常返回示例

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

错误码

更多详情，请参见错误码。