Neptune 参数 API - Amazon Neptune
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Neptune 参数 API

结构:

操作:

参数(结构)

指定参数。

字段

  • AllowedValues – UTF-8 字符串。

    指定参数值的有效范围。

  • ApplyMethod – UTF-8 字符串(有效值:immediate="" | pending-reboot="")。

    指示何时应用参数更新。

  • ApplyType – UTF-8 字符串。

    指定引擎特定的参数类型。

  • DataType – UTF-8 字符串。

    指定参数的有效数据类型。

  • Description – UTF-8 字符串。

    提供参数的说明。

  • IsModifiable – 布尔值。

    指示参数可以修改 (true) 还是不能修改 (false)。一些参数具有安全或操作影响,会阻止更改这些参数。

  • MinimumEngineVersion – UTF-8 字符串。

    参数可以应用到的最早引擎版本。

  • ParameterName – UTF-8 字符串。

    指定参数的名称。

  • ParameterValue – UTF-8 字符串。

    指定参数的值。

  • Source – UTF-8 字符串。

    指示参数值的源。

DBParameterGroup(结构)

包含 Amazon Neptune 数据库参数组的详细信息。

此数据类型用作 DescribeDBParameterGroups(操作) 操作中的响应元素。

字段

  • DBParameterGroupArn – UTF-8 字符串。

    数据库参数组的 Amazon 资源名称 (ARN)。

  • DBParameterGroupFamily – UTF-8 字符串。

    提供此数据库参数组兼容的数据库参数组系列的名称。

  • DBParameterGroupName – UTF-8 字符串。

    提供数据库参数组的名称。

  • Description – UTF-8 字符串。

    为此数据库参数组提供客户指定的描述。

DBParameterGroup 用作下列对象的响应元素:

DBClusterParameterGroup(结构)

包含 Amazon Neptune 数据库集群参数组的详细信息。

此数据类型用作 DescribeDBClusterParameterGroups(操作) 操作中的响应元素。

字段

  • DBClusterParameterGroupArn – UTF-8 字符串。

    数据库集群参数组的 Amazon 资源名称 (ARN)。

  • DBClusterParameterGroupName – UTF-8 字符串。

    提供数据库集群参数组的名称。

  • DBParameterGroupFamily – UTF-8 字符串。

    提供此数据库集群参数组兼容的数据库参数组系列的名称。

  • Description – UTF-8 字符串。

    为此数据库集群参数组提供客户指定的描述。

DBClusterParameterGroup 用作下列对象的响应元素:

DBParameterGroupStatus(结构)

数据库参数组的状态。

此数据类型用作下列操作中的响应元素:

字段

  • DBParameterGroupName – UTF-8 字符串。

    数据库参数组的名称。

  • ParameterApplyStatus – UTF-8 字符串。

    参数更新的状态。

CopyDBParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:copy-db-parameter-group,Python 的名字是:copy_db_parameter_group.

复制指定的数据库参数组。

请求

  • SourceDBParameterGroupIdentifier(在 CLI 中:--source-db-parameter-group-identifier,或者在 Python 中:source_db_parameter_group_identifier) –:必需 UTF-8 字符串。

    源数据库参数组的标识符或 ARN。有关创建 ARN 的信息,请参阅构造 Amazon 资源名称 (ARN)

    约束:

    • 必须指定有效的数据库参数组。

    • 必须指定有效的数据库参数组标识符,例如 my-db-param-group,或者有效的 ARN。

  • Tags(在 CLI 中:--tags,或者在 Python 中:tags) — 数组标签标记对象。

    要分配给复制数据库参数组的标签。

  • TargetDBParameterGroupDescription(在 CLI 中:--target-db-parameter-group-description,或者在 Python 中:target_db_parameter_group_description) –:必需 UTF-8 字符串。

    复制的数据库参数组的描述。

  • TargetDBParameterGroupIdentifier(在 CLI 中:--target-db-parameter-group-identifier,或者在 Python 中:target_db_parameter_group_identifier) –:必需 UTF-8 字符串。

    复制的数据库参数组的标识符。

    约束:

    • 不能为 null 或空。

    • 必须包含 1 到 255 个字母、数字或连字符。

    • 第一个字符必须是字母。

    • 不能以连字符结束或包含两个连续连字符。

    示例:my-db-parameter-group

响应

包含 Amazon Neptune 数据库参数组的详细信息。

此数据类型用作 DescribeDBParameterGroups(操作) 操作中的响应元素。

  • DBParameterGroupArn(在 CLI 中:--db-parameter-group-arn,或者在 Python 中:db_parameter_group_arn) – UTF-8 字符串。

    数据库参数组的 Amazon 资源名称 (ARN)。

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) – UTF-8 字符串。

    提供此数据库参数组兼容的数据库参数组系列的名称。

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) – UTF-8 字符串。

    提供数据库参数组的名称。

  • Description(在 CLI 中:--description,或者在 Python 中:description) – UTF-8 字符串。

    为此数据库参数组提供客户指定的描述。

CopyDBClusterParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:copy-db-cluster-parameter-group,Python 的名字是:copy_db_cluster_parameter_group.

复制指定的数据库集群参数组。

请求

  • SourceDBClusterParameterGroupIdentifier(在 CLI 中:--source-db-cluster-parameter-group-identifier,或者在 Python 中:source_db_cluster_parameter_group_identifier) –:必需 UTF-8 字符串。

    源数据库集群参数组的标识符或 Amazon 资源名称 (ARN)。有关创建 ARN 的信息,请参阅构造 Amazon 资源名称 (ARN)

    约束:

    • 必须指定有效的数据库集群参数组。

    • 如果源数据库集群参数组与副本位于相同 Amazon 区域中,则指定有效的数据库参数组标识符,例如。my-db-cluster-param-group或有效的 ARN。

    • 如果源数据库集群参数组与副本位于不同的 Amazon 区域中,则指定有效的数据库集群参数组 ARN,例如。arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

  • Tags(在 CLI 中:--tags,或者在 Python 中:tags) — 数组标签标记对象。

    要分配给复制数据库集群参数组的标签。

  • TargetDBClusterParameterGroupDescription(在 CLI 中:--target-db-cluster-parameter-group-description,或者在 Python 中:target_db_cluster_parameter_group_description) –:必需 UTF-8 字符串。

    复制的数据库集群参数组的描述。

  • TargetDBClusterParameterGroupIdentifier(在 CLI 中:--target-db-cluster-parameter-group-identifier,或者在 Python 中:target_db_cluster_parameter_group_identifier) –:必需 UTF-8 字符串。

    复制的数据库集群参数组的标识符。

    约束:

    • 不能为 null 或空

    • 必须包含 1 到 255 个字母、数字或连字符

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

    示例:my-cluster-param-group1

响应

包含 Amazon Neptune 数据库集群参数组的详细信息。

此数据类型用作 DescribeDBClusterParameterGroups(操作) 操作中的响应元素。

  • DBClusterParameterGroupArn(在 CLI 中:--db-cluster-parameter-group-arn,或者在 Python 中:db_cluster_parameter_group_arn) – UTF-8 字符串。

    数据库集群参数组的 Amazon 资源名称 (ARN)。

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) – UTF-8 字符串。

    提供数据库集群参数组的名称。

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) – UTF-8 字符串。

    提供此数据库集群参数组兼容的数据库参数组系列的名称。

  • Description(在 CLI 中:--description,或者在 Python 中:description) – UTF-8 字符串。

    为此数据库集群参数组提供客户指定的描述。

CreateDBParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:create-db-parameter-group,Python 的名字是:create_db_parameter_group.

创建新的数据库参数组。

最初创建数据库参数组时,使用的是数据库实例所用数据库引擎的默认参数。要向任何参数提供自定义值,您必须在创建之后使用 ModifyDBParameterGroup 对其进行修改。创建数据库参数组后,您需要使用 ModifyDBInstance 将它关联到数据库实例。将新数据库参数组关联到正在运行的数据库实例时,您需要重新启动数据库实例而不进行故障转移,以使新数据库参数组和关联设置生效。

重要

创建数据库参数组之后,您应至少等待 5 分钟,再创建使用该数据库参数组作为默认参数组的第一个数据库实例。这样,在将参数组用作新数据库实例的默认设置之前,Amazon Neptune 可以完成全部创建操作。这对于在为数据库实例创建默认数据库时十分关键的参数 (例如,由 character_set_database 参数定义的默认数据库字符集) 非常重要。您可以使用 Amazon Neptune 控制台的 Parameter Groups (参数组) 选项或使用 DescribeDBParameters 命令来验证是否已创建或修改数据库参数组。

请求

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) –:必需 UTF-8 字符串。

    数据库参数组系列名称。数据库参数组能且仅能与一个数据库参数组系列关联,只能应用到运行数据库引擎且引擎版本与该数据库参数组系列兼容的数据库实例上。

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) –:必需 UTF-8 字符串。

    数据库参数组的名称。

    约束:

    • 必须为 1 到 255 个字母、数字或连字符。

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

    注意

    此值以一个小写字符串存储。

  • Description(在 CLI 中:--description,或者在 Python 中:description) –:必需 UTF-8 字符串。

    数据库参数组的描述。

  • Tags(在 CLI 中:--tags,或者在 Python 中:tags) — 数组标签标记对象。

    要分配给新数据库参数组的标签。

响应

包含 Amazon Neptune 数据库参数组的详细信息。

此数据类型用作 DescribeDBParameterGroups(操作) 操作中的响应元素。

  • DBParameterGroupArn(在 CLI 中:--db-parameter-group-arn,或者在 Python 中:db_parameter_group_arn) – UTF-8 字符串。

    数据库参数组的 Amazon 资源名称 (ARN)。

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) – UTF-8 字符串。

    提供此数据库参数组兼容的数据库参数组系列的名称。

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) – UTF-8 字符串。

    提供数据库参数组的名称。

  • Description(在 CLI 中:--description,或者在 Python 中:description) – UTF-8 字符串。

    为此数据库参数组提供客户指定的描述。

CreateDBClusterParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:create-db-cluster-parameter-group,Python 的名字是:create_db_cluster_parameter_group.

创建新的数据库集群参数组。

数据库集群参数组中的参数应用到数据库集群中的所有实例。

最初创建数据库集群参数组时,使用的是数据库集群中实例所用数据库引擎的默认参数。为了提供针对任何参数的自定义值,您必须在创建缓存参数组之后使用ModifyDBClusterParameterGroup(操作)对其进行修改。创建数据库集群参数组后,您需要使用ModifyDBCluster(操作)将它关联到数据库集群。将新数据库集群参数组关联到正在运行的数据库集群时,您需要重新启动数据库集群中的数据库实例而不进行故障转移,以使新数据库集群参数组和关联设置生效。

重要

创建数据库集群参数组之后,您应至少等待 5 分钟,再创建使用该数据库集群参数组作为默认参数组的第一个数据库集群。这样,在将数据库集群参数组用作新数据库集群的默认设置之前,Amazon Neptune 可以完成全部创建操作。这对于在为数据库集群创建默认数据库时十分关键的参数(例如,由 character_set_database 参数定义的默认数据库字符集)非常重要。您可以使用参数组的选项Amazon Neptune 控制台或者DescribeDBClusterParameters(操作)命令来验证是否已创建或修改数据库集群参数组。

请求

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) –:必需 UTF-8 字符串。

    数据库集群参数组的名称。

    约束:

    • 必须与现有 DBClusterParameterGroup 的名称匹配。

    注意

    此值以一个小写字符串存储。

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) –:必需 UTF-8 字符串。

    数据库集群参数组系列名称。数据库集群参数组能且仅能与一个数据库集群参数组系列关联,只能应用到运行数据库引擎且引擎版本与该数据库集群参数组系列兼容的数据库集群上。

  • Description(在 CLI 中:--description,或者在 Python 中:description) –:必需 UTF-8 字符串。

    数据库集群参数组的描述。

  • Tags(在 CLI 中:--tags,或者在 Python 中:tags) — 数组标签标记对象。

    要分配给新数据库集群参数组的标签。

响应

包含 Amazon Neptune 数据库集群参数组的详细信息。

此数据类型用作 DescribeDBClusterParameterGroups(操作) 操作中的响应元素。

  • DBClusterParameterGroupArn(在 CLI 中:--db-cluster-parameter-group-arn,或者在 Python 中:db_cluster_parameter_group_arn) – UTF-8 字符串。

    数据库集群参数组的 Amazon 资源名称 (ARN)。

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) – UTF-8 字符串。

    提供数据库集群参数组的名称。

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) – UTF-8 字符串。

    提供此数据库集群参数组兼容的数据库参数组系列的名称。

  • Description(在 CLI 中:--description,或者在 Python 中:description) – UTF-8 字符串。

    为此数据库集群参数组提供客户指定的描述。

DeleteDBParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:delete-db-parameter-group,Python 的名字是:delete_db_parameter_group.

删除指定的 DBParameterGroup。要添加的 DBParameterGroup 不能与任何数据库实例关联。

请求

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) –:必需 UTF-8 字符串。

    数据库参数组的名称。

    约束:

    • 必须是现有数据库参数组的名称

    • 您无法删除默认数据库参数组

    • 不能与任何数据库实例关联

响应

  • 无响应参数。

DeleteDBClusterParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:delete-db-cluster-parameter-group,Python 的名字是:delete_db_cluster_parameter_group.

删除指定的数据库集群参数组。要添加的数据库集群参数组不能与任何数据库集群关联。

请求

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) –:必需 UTF-8 字符串。

    数据库集群参数组的名称。

    约束:

    • 必须是现有数据库集群参数组的名称。

    • 您无法删除默认的数据库集群参数组。

    • 不能与任何数据库集群关联。

响应

  • 无响应参数。

ModifyDBParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:modify-db-parameter-group,Python 的名字是:modify_db_parameter_group.

修改数据库参数组的参数。要修改多个参数,请提交以下对象的列表:ParameterNameParameterValueApplyMethod。在单个请求中,最多可以修改 20 个参数。

注意

对动态参数所做的更改将立即应用。对静态参数所做的更改需要在重启(不执行故障转移)与参数组关联的数据库实例后才生效。

重要

修改数据库参数组之后,您应至少等待 5 分钟,再创建使用该数据库参数组作为默认参数组的第一个数据库实例。这样,在将参数组用作新数据库实例的默认设置之前,Amazon Neptune 可以完成全部修改操作。这对于在为数据库实例创建默认数据库时十分关键的参数 (例如,由 character_set_database 参数定义的默认数据库字符集) 非常重要。您可以使用 Amazon Neptune 控制台的 Parameter Groups (参数组) 选项或使用 DescribeDBParameters 命令来验证是否已创建或修改数据库参数组。

请求

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) –:必需 UTF-8 字符串。

    数据库参数组的名称。

    约束:

    • 如果提供,必须与现有 DBParameterGroup 的名称匹配。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) –:必需 数组参数参数对象。

    参数名称、值以及参数更新应用方法的数组。必须至少提供一个参数名称、值和应用方法;后续参数是可选的。在单个请求中,最多可以修改 20 个参数。

    有效值(对于应用方法):immediate | pending-reboot

    注意

    您只能使用具有动态参数的即时值。您可以为动态参数和静态参数使用等待重启值,在您重启数据库实例而不进行故障转移时应用更改。

响应

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) – UTF-8 字符串。

    提供数据库参数组的名称。

ModifyDBClusterParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:modify-db-cluster-parameter-group,Python 的名字是:modify_db_cluster_parameter_group.

修改数据库集群参数组的参数。要修改多个参数,请提交以下对象的列表:ParameterNameParameterValueApplyMethod。在单个请求中,最多可以修改 20 个参数。

注意

对动态参数所做的更改将立即应用。对静态参数所做的更改需要在重启(不执行故障转移)与参数组关联的数据库集群后才生效。

重要

创建数据库集群参数组之后,您应至少等待 5 分钟,再创建使用该数据库集群参数组作为默认参数组的第一个数据库集群。这样,在将参数组用作新数据库集群的默认设置之前,Amazon Neptune 可以完成全部创建操作。这对于在为数据库集群创建默认数据库时十分关键的参数(例如,由 character_set_database 参数定义的默认数据库字符集)非常重要。您可以使用 Amazon Neptune 控制台的 Parameter Groups (参数组) 选项或DescribeDBClusterParameters(操作)命令来验证是否已创建或修改数据库集群参数组。

请求

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) –:必需 UTF-8 字符串。

    要修改的数据库集群参数组的名称。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) –:必需 数组参数参数对象。

    要修改的数据库集群参数组中的参数列表。

响应

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) – UTF-8 字符串。

    数据库集群参数组的名称。

    约束:

    • 必须为 1 到 255 个字母或数字。

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

    注意

    此值以一个小写字符串存储。

ResetDBParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:reset-db-parameter-group,Python 的名字是:reset_db_parameter_group.

将数据库参数组的参数修改为引擎/系统默认值。要重置特定参数,请提供以下内容的列表:ParameterNameApplyMethod。要重置整个数据库参数组,请指定 DBParameterGroup 名称和 ResetAllParameters 参数。重置整个组时,动态参数立即更新,静态参数设置为 pending-reboot 以便在下次数据库实例重新启动或 RebootDBInstance 请求时生效。

请求

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) –:必需 UTF-8 字符串。

    数据库参数组的名称。

    约束:

    • 必须与现有 DBParameterGroup 的名称匹配。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) — 数组参数参数对象。

    要重置整个数据库参数组,请指定 DBParameterGroup 名称和 ResetAllParameters 参数。要重置特定参数,请提供以下内容的列表:ParameterNameApplyMethod。在单个请求中,最多可以修改 20 个参数。

    有效值(对于应用方法):pending-reboot

  • ResetAllParameters(在 CLI 中:--reset-all-parameters,或者在 Python 中:reset_all_parameters) – Boolean.

    指定将数据库参数组中的所有参数重置为默认值 (true) 还是不重置 (false)。

    默认值:true

响应

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) – UTF-8 字符串。

    提供数据库参数组的名称。

ResetDBClusterParameterGroup(操作)

        此 API 的 Amazon CLI 名称为:reset-db-cluster-parameter-group,Python 的名字是:reset_db_cluster_parameter_group.

将数据库集群参数组的参数修改为默认值。要重置特定参数,请提交以下内容的列表:ParameterNameApplyMethod。要重置整个数据库集群参数组,请指定 DBClusterParameterGroupNameResetAllParameters 参数。

重置整个组时,动态参数立即更新,静态参数设置为 pending-reboot 以便在下次数据库实例重新启动或 RebootDBInstance(操作) 请求时生效。对于数据库集群中您希望将更新的静态参数应用到的每个数据库实例,您必须调用 RebootDBInstance(操作)

请求

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) –:必需 UTF-8 字符串。

    要重置的数据库集群参数组的名称。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) — 数组参数参数对象。

    数据库集群参数组中要重置为默认值的参数名称列表。如果 ResetAllParameters 参数设置为 true,则无法使用此参数。

  • ResetAllParameters(在 CLI 中:--reset-all-parameters,或者在 Python 中:reset_all_parameters) – Boolean.

    值设置为 true 可将数据库集群参数组中的所有参数重置为其默认值,否则为 false。如果为 Parameters 参数指定了参数名称列表,您无法使用此参数。

响应

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) – UTF-8 字符串。

    数据库集群参数组的名称。

    约束:

    • 必须为 1 到 255 个字母或数字。

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

    注意

    此值以一个小写字符串存储。

DescribeDBParameters(操作)

        此 API 的 Amazon CLI 名称为:describe-db-parameters,Python 的名字是:describe_db_parameters.

返回特定数据库参数组的详细参数列表。

请求

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) –:必需 UTF-8 字符串。

    要返回其详细信息的特定数据库参数组的名称。

    约束:

    • 如果提供,必须与现有 DBParameterGroup 的名称匹配。

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持此参数。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeDBParameters 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

  • Source(在 CLI 中:--source,或者在 Python 中:source) – UTF-8 字符串。

    要返回的参数类型。

    默认值:返回所有参数类型

    有效值:user | system | engine-default

响应

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) — 数组参数参数对象。

    参数(结构) 值的列表。

DescribeDBParameterGroups(操作)

        此 API 的 Amazon CLI 名称为:describe-db-parameter-groups,Python 的名字是:describe_db_parameter_groups.

返回 DBParameterGroup 描述的列表。如果指定了 DBParameterGroupName,则列表中只包含指定数据库参数组的描述。

请求

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或者在 Python 中:db_parameter_group_name) – UTF-8 字符串。

    要返回其详细信息的特定数据库参数组的名称。

    约束:

    • 如果提供,必须与现有 DBClusterParameterGroup 的名称匹配。

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持此参数。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeDBParameterGroups 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

响应

  • DBParameterGroups(在 CLI 中:--db-parameter-groups,或者在 Python 中:db_parameter_groups) — 数组DBParameterGroupdbParameterGroup 对象。

    DBParameterGroup(结构) 实例的列表。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

DescribeDBClusterParameters(操作)

        此 API 的 Amazon CLI 名称为:describe-db-cluster-parameters,Python 的名字是:describe_db_cluster_parameters.

返回特定数据库集群参数组的详细参数列表。

请求

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) –:必需 UTF-8 字符串。

    要返回其参数详细信息的特定数据库集群参数组的名称。

    约束:

    • 如果提供,必须与现有 DBClusterParameterGroup 的名称匹配。

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持此参数。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeDBClusterParameters 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

  • Source(在 CLI 中:--source,或者在 Python 中:source) – UTF-8 字符串。

    指示仅返回特定源的参数的值。参数源可以是 engineservicecustomer

响应

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeDBClusterParameters 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) — 数组参数参数对象。

    提供数据库集群参数组的参数列表。

DescribeDBClusterParameterGroups(操作)

        此 API 的 Amazon CLI 名称为:describe-db-cluster-parameter-groups,Python 的名字是:describe_db_cluster_parameter_groups.

返回 DBClusterParameterGroup 描述的列表。如果指定了 DBClusterParameterGroupName 参数,则列表中只包含指定数据库集群参数组的描述。

请求

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) – UTF-8 字符串。

    要返回其详细信息的特定数据库集群参数组的名称。

    约束:

    • 如果提供,必须与现有 DBClusterParameterGroup 的名称匹配。

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持此参数。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeDBClusterParameterGroups 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

响应

  • DBClusterParameterGroups(在 CLI 中:--db-cluster-parameter-groups,或者在 Python 中:db_cluster_parameter_groups) — 数组DBClusterParameterGroupdbCluster ParameterGroup 对象。

    数据库集群参数组的列表。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeDBClusterParameterGroups 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

DescribeEngineDefaultParameters(操作)

        此 API 的 Amazon CLI 名称为:describe-engine-default-parameters,Python 的名字是:describe_engine_default_parameters.

返回指定数据库引擎的默认引擎和系统参数信息。

请求

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) –:必需 UTF-8 字符串。

    数据库参数组系列的名称。

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeEngineDefaultParameters 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

响应

包含 DescribeEngineDefaultParameters(操作) 操作的成功调用的结果。

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) – UTF-8 字符串。

    指定引擎默认参数应用到的数据库参数组系列的名称。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 EngineDefaults 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) — 数组参数参数对象。

    包含引擎默认参数的列表。

DescribeEngineDefaultClusterParameters(操作)

        此 API 的 Amazon CLI 名称为:describe-engine-default-cluster-parameters,Python 的名字是:describe_engine_default_cluster_parameters.

返回集群数据库引擎的默认引擎和系统参数信息。

请求

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) –:必需 UTF-8 字符串。

    要返回其引擎参数信息的数据库集群参数组系列的名称。

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持此参数。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeEngineDefaultClusterParameters 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

响应

包含 DescribeEngineDefaultParameters(操作) 操作的成功调用的结果。

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) – UTF-8 字符串。

    指定引擎默认参数应用到的数据库参数组系列的名称。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 EngineDefaults 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • Parameters(在 CLI 中:--parameters,或者在 Python 中:parameters) — 数组参数参数对象。

    包含引擎默认参数的列表。