{
  "name": "ssm",
  "display_name": "凭据管理系统",
  "description": "介绍如何使用API对凭据管理系统进行操作，包括凭据启用、停用等。",
  "domain": "security",
  "api_version": "2019-09-23",
  "endpoint": "ssm.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateProductSecret",
      "description": "创建云产品凭据",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。",
          "example": "test2-db-secret"
        },
        {
          "name": "UserNamePrefix",
          "type": "string",
          "required": true,
          "description": "用户账号名前缀，由用户自行指定，长度限定在8个字符以内， 可选字符集包括： 数字字符：[0, 9]， 小写字符：[a, z]， 大写字符：[A, Z]， 特殊字符(全英文符号)：下划线(_)， 前缀必须以大写或小写字母开头。",
          "example": "test_prefix"
        },
        {
          "name": "ProductName",
          "type": "string",
          "required": true,
          "description": "凭据所绑定的云产品名称，如Mysql，可以通过DescribeSupportedProducts接口获取所支持的云产品名称。",
          "example": "Mysql"
        },
        {
          "name": "InstanceID",
          "type": "string",
          "required": true,
          "description": "云产品实例ID。",
          "example": "cdb-n4j3y33j"
        },
        {
          "name": "Domains",
          "type": "array",
          "required": true,
          "description": "账号的域名，IP形式，支持填入%。",
          "example": "[\"%\",\"192.168.0.%\"]",
          "item_type": "string"
        },
        {
          "name": "PrivilegesList",
          "type": "array",
          "required": true,
          "description": "将凭据与云产品实例绑定时，需要授予的权限列表。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "PrivilegeName",
              "type": "string",
              "required": true,
              "description": "权限名称，当前可选： GlobalPrivileges DatabasePrivileges TablePrivileges ColumnPrivileges 当权限为DatabasePrivileges时，必须通过参数Database指定数据库名； 当权限为TablePrivileges时，必须通过参数Database和TableName指定数据库名以及数据库中的表名； 当权限为ColumnPrivileges时，必须通过参数Database、TableName和CoulmnName指定数据库、数据库中的表名以及表中的列名。",
              "example": "GlobalPrivileges"
            },
            {
              "name": "Privileges",
              "type": "array",
              "required": true,
              "description": "权限列表。 对于Mysql产品来说，可选权限值为： 1. GlobalPrivileges 中权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"PROCESS\", \"DROP\",\"REFERENCES\",\"INDEX\",\"ALTER\",\"SHOW DATABASES\",\"CREATE TEMPORARY TABLES\",\"LOCK TABLES\",\"EXECUTE\",\"CREATE VIEW\",\"SHOW VIEW\",\"CREATE ROUTINE\",\"ALTER ROUTINE\",\"EVENT\",\"TRIGGER\"。 注意，不传该参数表示清除该权限。 2. DatabasePrivileges 权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"DROP\",\"...",
              "example": "[ \t\t\t\t\"SELECT\" \t\t\t]",
              "item_type": "string"
            },
            {
              "name": "Database",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为DatabasePrivileges时这个值才有效。",
              "example": "testdb"
            },
            {
              "name": "TableName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为TablePrivileges时这个值才有效，并且此时需要填充Database显式指明所在的数据库实例。",
              "example": "t_test"
            },
            {
              "name": "ColumnName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为ColumnPrivileges时这个值才生效，并且此时必须填充： Database - 显式指明所在的数据库实例。 TableName - 显式指明所在表",
              "example": "name"
            },
            {
              "name": "SchemaName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为SchemaPrivileges时这个值才生效，并且此时必须填充： 目前仅postgresSQL需要",
              "example": "test_schema"
            },
            {
              "name": "SequenceName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为SequencePrivileges时这个值才生效，并且此时必须填充： 目前仅postgresSQL需要",
              "example": "sequence"
            },
            {
              "name": "ProcedureName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为ProcedurePrivileges时这个值才生效，并且此时必须填充： 目前仅postgresSQL需要",
              "example": "procedure"
            },
            {
              "name": "TypeName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为TypePrivileges时这个值才生效，并且此时必须填充： 目前仅postgresSQL需要",
              "example": "type"
            },
            {
              "name": "FunctionName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为FunctionPrivileges时这个值才生效，并且此时必须填充： 目前仅postgresSQL需要",
              "example": "function"
            },
            {
              "name": "ViewName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为ViewPrivileges时这个值才生效，并且此时必须填充： 目前仅postgresSQL需要",
              "example": "vice"
            },
            {
              "name": "MatviewName",
              "type": "string",
              "required": false,
              "description": "仅当PrivilegeName为MatviewPrivileges时这个值才生效，并且此时必须填充： 目前仅postgresSQL需要",
              "example": "matview"
            }
          ]
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述信息，用于详细描述用途等，最大支持2048字节。",
          "example": "测试数据库凭据创建"
        },
        {
          "name": "KmsKeyId",
          "type": "string",
          "required": false,
          "description": "指定对凭据进行加密的KMS CMK。 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。 您也可以指定在同region 下自行创建的KMS CMK进行加密。",
          "example": "6abd1fdb-86d4-11ef-b72d-52540089bc41"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签列表。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "env"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "dev"
            }
          ]
        },
        {
          "name": "RotationBeginTime",
          "type": "string",
          "required": false,
          "description": "用户自定义的开始轮转时间，格式：2006-01-02 15:04:05。 当EnableRotation为True时，此参数必填。",
          "example": "2006-01-02 15:04:05"
        },
        {
          "name": "EnableRotation",
          "type": "boolean",
          "required": false,
          "description": "是否开启轮转 True -- 开启 False -- 不开启 如果不指定，默认为False。",
          "example": "true"
        },
        {
          "name": "RotationFrequency",
          "type": "integer",
          "required": false,
          "description": "轮转周期，以天为单位，默认为1天。",
          "example": "1"
        },
        {
          "name": "KmsHsmClusterId",
          "type": "string",
          "required": false,
          "description": "KMS的独享集群的ID。当KmsKeyId为空,并且用户的KMS存在有效的HsmClusterId时有效。",
          "example": "cls-hsm-wiwmm3np"
        },
        {
          "name": "AccountRemark",
          "type": "string",
          "required": false,
          "description": "账户备注",
          "example": "托管账户"
        }
      ],
      "required": [
        "SecretName",
        "UserNamePrefix",
        "ProductName",
        "InstanceID",
        "Domains",
        "PrivilegesList"
      ]
    },
    {
      "name": "CreateSSHKeyPairSecret",
      "description": "创建用于托管SSH密钥对的凭据",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。",
          "example": "test2-sshkey-secret"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "密钥对创建后所属的项目ID。",
          "example": "0"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述信息，用于详细描述用途等，最大支持2048字节。",
          "example": "描述信息"
        },
        {
          "name": "KmsKeyId",
          "type": "string",
          "required": false,
          "description": "指定对凭据进行加密的KMS CMK。 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。 您也可以指定在同region 下自行创建的KMS CMK进行加密。",
          "example": "6abd1fdb-86d4-11ef-b72d-52540089bc41"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签列表。",
          "example": "[{\"TagKey\":\"env\",\"TagValue\":\"dev\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "env"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "dev"
            }
          ]
        },
        {
          "name": "SSHKeyName",
          "type": "string",
          "required": false,
          "description": "用户自定义输入的SSH密钥对的名称，可由数字，字母和下划线组成，只能以数字和字母开头，长度不超过25个字符。",
          "example": "test2_key"
        },
        {
          "name": "KmsHsmClusterId",
          "type": "string",
          "required": false,
          "description": "KMS的独享集群的ID。当KmsKeyId为空,并且用户的KMS存在有效的HsmClusterId时有效。",
          "example": "cls-hsm-wiwmm3np"
        }
      ],
      "required": [
        "SecretName",
        "ProjectId"
      ]
    },
    {
      "name": "CreateSecret",
      "description": "创建新的凭据信息，通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。一旦创建不可修改。",
          "example": "test_secret"
        },
        {
          "name": "VersionId",
          "type": "string",
          "required": false,
          "description": "凭据版本，查询凭据信息时需要根据SecretName 和 VersionId进行查询，最长64 字节，使用字母、数字或者 - _ . 的组合并且以字母或数字开头。若为空，则使用默认的初始凭据版本号。可选，若为空或该凭据为云产品类凭据，则该版本号默认为 SSM_Current。",
          "example": "v1.0"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述信息，用于详细描述用途等，最大支持2048字节。",
          "example": "test create secret"
        },
        {
          "name": "KmsKeyId",
          "type": "string",
          "required": false,
          "description": "指定对凭据进行加密的KMS CMK。如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。您也可以指定在同region 下自行创建的KMS CMK进行加密。",
          "example": "6abd1fdb-86d4-11ef-b72d-52540089bc41"
        },
        {
          "name": "SecretType",
          "type": "integer",
          "required": false,
          "description": "凭据类型，默认为0自定义凭据。",
          "example": "0"
        },
        {
          "name": "SecretBinary",
          "type": "string",
          "required": false,
          "description": "二进制凭据信息base64编码后的明文。SecretBinary 和 SecretString 必须且只能设置一个，最大支持32KB字节。",
          "example": "5Yet5o2udmFsdWUyCg=="
        },
        {
          "name": "SecretString",
          "type": "string",
          "required": false,
          "description": "文本类型凭据信息明文（不需要进行base64编码）。SecretBinary 和 SecretString 必须且只能设置一个，最大支持32KB字节。",
          "example": "lzc-env"
        },
        {
          "name": "AdditionalConfig",
          "type": "string",
          "required": false,
          "description": "JSON 格式字符串，用于指定特定凭据类型的额外配置。",
          "example": "key1"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签列表",
          "example": "[{\"TagKey\":\"env\",\"TagValue\":\"dev\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "env"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "dev"
            }
          ]
        },
        {
          "name": "KmsHsmClusterId",
          "type": "string",
          "required": false,
          "description": "KMS的独享集群的ID。当KmsKeyId为空,并且用户的KMS存在有效的HsmClusterId时有效。",
          "example": "cls-hsm-wiwmm3np"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "DeleteSecret",
      "description": "删除指定的凭据信息，可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据，在删除日期到达之前状态为 PendingDelete，并可以通过RestoreSecret 进行恢复，超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行（计划）删除操作。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要删除的凭据名称。",
          "example": "testName"
        },
        {
          "name": "RecoveryWindowInDays",
          "type": "integer",
          "required": false,
          "description": "指定计划删除日期，单位（天），0（默认）表示立即删除， 1-30 表示预留的天数，超出该日期之后彻底删除。 当凭据类型为SSH密钥对凭据时，此字段只能取值只能为0。",
          "example": "1"
        },
        {
          "name": "CleanSSHKey",
          "type": "boolean",
          "required": false,
          "description": "当凭据类型为SSH密钥对凭据时，此字段有效，取值： True -- 表示不仅仅清理此凭据中存储的SSH密钥信息，还会将SSH密钥对从CVM侧进行清理。注意，如果SSH密钥此时绑定了CVM实例，那么会清理失败。 False -- 表示仅仅清理此凭据中存储的SSH密钥信息，不在CVM进侧进行清理。",
          "example": "False"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "DeleteSecretVersion",
      "description": "该接口用于直接删除指定凭据下的单个版本凭据，删除操作立即生效，对所有状态下的凭据版本都可以删除。 本接口仅适用于用户自定义凭据，本接口不能对云产品凭据进行操作。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定凭据名称。",
          "example": "lzc-testss"
        },
        {
          "name": "VersionId",
          "type": "string",
          "required": true,
          "description": "指定该名称下需要删除的凭据的版本号。",
          "example": "v1.0"
        }
      ],
      "required": [
        "SecretName",
        "VersionId"
      ]
    },
    {
      "name": "DescribeAsyncRequestInfo",
      "description": "查询异步任务的执行结果",
      "status": "online",
      "parameters": [
        {
          "name": "FlowID",
          "type": "integer",
          "required": true,
          "description": "异步任务ID号",
          "example": "43414"
        }
      ],
      "required": [
        "FlowID"
      ]
    },
    {
      "name": "DescribeRotationDetail",
      "description": "查询凭据轮转策略详情。 本接口只适用于云产品凭据。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要获取凭据轮转详细信息的凭据名称。",
          "example": "test3-db-secret"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "DescribeRotationHistory",
      "description": "查询凭据轮转历史版本。 本接口仅适用于云产品凭据。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要获取凭据轮转历史的凭据名称。",
          "example": "test3-db-secret"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "DescribeSecret",
      "description": "获取凭据的详细属性信息。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要获取凭据详细信息的凭据名称。",
          "example": "lzctest"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "DescribeSupportedProducts",
      "description": "查询支持的云产品列表",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DisableSecret",
      "description": "停用指定的凭据，停用后状态为 Disabled，无法通过接口获取该凭据的明文。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定停用的凭据名称。",
          "example": "lzc-testss"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "EnableSecret",
      "description": "该接口用于开启凭据，状态为Enabled。可以通过 GetSecretValue 接口获取凭据明文。处于PendingDelete状态的凭据不能直接开启，需要通过RestoreSecret 恢复后再开启使用。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定启用凭据的名称。",
          "example": "test3-secret"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "GetRegions",
      "description": "获取控制台展示region列表",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "GetSSHKeyPairValue",
      "description": "获取SSH密钥对凭据明文信息。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": false,
          "description": "凭据名称，此凭据只能为SSH密钥对凭据类型。",
          "example": "test2-sshkey-secret"
        },
        {
          "name": "SSHKeyId",
          "type": "string",
          "required": false,
          "description": "密钥对ID，是云服务器中密钥对的唯一标识。",
          "example": "skey-e0vbh2ts"
        }
      ],
      "required": []
    },
    {
      "name": "GetSecretValue",
      "description": "对于用户自定义凭据，通过指定凭据名称和版本来获取凭据的明文信息； 对于云产品凭据如Mysql凭据，通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息，如果要获取当前正在使用的凭据版本的明文，需要将版本号指定为：SSM_Current。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定凭据的名称。",
          "example": "test_secret"
        },
        {
          "name": "VersionId",
          "type": "string",
          "required": true,
          "description": "指定对应凭据的版本号。 对于云产品凭据如Mysql凭据，通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息，如果要获取当前正在使用的凭据版本的明文，需要将版本号指定为：SSM_Current。",
          "example": "v1.0"
        }
      ],
      "required": [
        "SecretName",
        "VersionId"
      ]
    },
    {
      "name": "GetServiceStatus",
      "description": "该接口用户获取用户SecretsManager服务开通状态。",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "ListSecretVersionIds",
      "description": "该接口用于获取指定凭据下的版本列表信息",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "凭据名称",
          "example": "test3-secret"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "ListSecrets",
      "description": "该接口用于获取所有凭据的详细列表，可以指定过滤字段、排序方式等。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询列表的起始位置，以0开始，不设置默认为0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "单次查询返回的最大数量，0或不设置则使用默认值 20。",
          "example": "2"
        },
        {
          "name": "OrderType",
          "type": "integer",
          "required": false,
          "description": "根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。",
          "example": "1"
        },
        {
          "name": "State",
          "type": "integer",
          "required": false,
          "description": "根据凭据状态进行过滤。 默认为0表示查询全部。 1 -- 表示查询Enabled 凭据列表。 2 -- 表示查询Disabled 凭据列表。 3 -- 表示查询PendingDelete 凭据列表。 4 -- 表示PendingCreate。 5 -- 表示CreateFailed。 其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效",
          "example": "1"
        },
        {
          "name": "SearchSecretName",
          "type": "string",
          "required": false,
          "description": "根据凭据名称进行过滤，为空表示不过滤。",
          "example": "testName"
        },
        {
          "name": "TagFilters",
          "type": "array",
          "required": false,
          "description": "标签过滤条件。",
          "example": "[{\"TagKey\":\"env\",\"TagValue\":[\"dev\"]}]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "env"
            },
            {
              "name": "TagValue",
              "type": "array",
              "required": false,
              "description": "标签值",
              "example": "dev",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "SecretType",
          "type": "integer",
          "required": false,
          "description": "0 -- 表示用户自定义凭据，默认为0。 1 -- 表示用户云产品凭据。 2 -- 表示SSH密钥对凭据。 3 -- 表示云API密钥对凭据。",
          "example": "1"
        },
        {
          "name": "ProductName",
          "type": "string",
          "required": false,
          "description": "此参数仅在SecretType参数值为1时生效， 当SecretType值为1时： 如果ProductName值为空，则表示查询所有类型的云产品凭据； 如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据； 如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据； 支持的云产品列表请通过接口：DescribeSupportedProducts进\ufffd...",
          "example": "Mysql"
        }
      ],
      "required": []
    },
    {
      "name": "PutSecretValue",
      "description": "该接口在指定名称的凭据下增加新版本的凭据内容，一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。 本接口仅适用于用户自定义凭据，对云产品凭据不能操作。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要增加版本的凭据名称。",
          "example": "lzc-testss"
        },
        {
          "name": "VersionId",
          "type": "string",
          "required": true,
          "description": "指定新增加的版本号，最长64 字节，使用字母、数字或者 - _ . 的组合并且以字母或数字开头。",
          "example": "v2.0"
        },
        {
          "name": "SecretBinary",
          "type": "string",
          "required": false,
          "description": "二进制凭据信息，使用base64编码。 SecretBinary 和 SecretString 必须且只能设置一个。",
          "example": "5Yet5o2udmFsdWUyCg=="
        },
        {
          "name": "SecretString",
          "type": "string",
          "required": false,
          "description": "文本类型凭据信息明文（不需要进行base64编码），SecretBinary 和 SecretString 必须且只能设置一个。",
          "example": "test_v2"
        }
      ],
      "required": [
        "SecretName",
        "VersionId"
      ]
    },
    {
      "name": "RestoreSecret",
      "description": "该接口用于恢复计划删除（PendingDelete状态）中的凭据，取消计划删除。取消计划删除的凭据将处于Disabled 状态，如需恢复使用，通过EnableSecret 接口开启凭据。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要恢复的凭据名称。",
          "example": "lzc-testss"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "RotateProductSecret",
      "description": "轮转云产品凭据或云API密钥对凭据。 该接口仅适用于处于Enabled状态的云产品凭据或处于Enable状态的云API密钥对凭据，对于其他状态的云产品凭据或云API密钥对凭据或用户自定义凭据不适用。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "需要轮转的凭据名。",
          "example": "test3-db-secret"
        }
      ],
      "required": [
        "SecretName"
      ]
    },
    {
      "name": "UpdateDescription",
      "description": "该接口用于修改指定凭据的描述信息，仅能修改Enabled 和 Disabled 状态的凭据。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要更新描述信息的凭据名。",
          "example": "lzc-testss"
        },
        {
          "name": "Description",
          "type": "string",
          "required": true,
          "description": "新的描述信息，最大长度2048个字节。",
          "example": "new desc"
        }
      ],
      "required": [
        "SecretName",
        "Description"
      ]
    },
    {
      "name": "UpdateRotationStatus",
      "description": "设置云产品凭据轮转策略，可以设置： 是否开启轮转 轮转周期 轮转开始时间",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "云产品凭据名称。",
          "example": "test3-db-secret"
        },
        {
          "name": "EnableRotation",
          "type": "boolean",
          "required": true,
          "description": "是否开启轮转。 true -- 开启轮转； false -- 禁止轮转。",
          "example": "True"
        },
        {
          "name": "Frequency",
          "type": "integer",
          "required": false,
          "description": "轮转周期，以天为单位，最小为30天，最大为365天。",
          "example": "30"
        },
        {
          "name": "RotationBeginTime",
          "type": "string",
          "required": false,
          "description": "用户设置的期望开始轮转时间，格式为：2006-01-02 15:04:05。 当EnableRotation为true时，如果不填RotationBeginTime，则默认填充为当前时间。",
          "example": "2006-01-02 15:04:05"
        }
      ],
      "required": [
        "SecretName",
        "EnableRotation"
      ]
    },
    {
      "name": "UpdateSecret",
      "description": "该接口用于更新指定凭据名称和版本号的内容，调用该接口会对新的凭据内容加密后覆盖旧的内容。仅允许更新Enabled 和 Disabled 状态的凭据。 本接口仅适用于用户自定义凭据，不能对云产品凭据操作。",
      "status": "online",
      "parameters": [
        {
          "name": "SecretName",
          "type": "string",
          "required": true,
          "description": "指定需要更新凭据内容的名称。",
          "example": "lzc-testss"
        },
        {
          "name": "VersionId",
          "type": "string",
          "required": true,
          "description": "指定需要更新凭据内容的版本号。",
          "example": "v1.0"
        },
        {
          "name": "SecretBinary",
          "type": "string",
          "required": false,
          "description": "新的凭据内容为二进制的场景使用该字段，并使用base64进行编码。 SecretBinary 和 SecretString 只能一个不为空。",
          "example": "5Yet5o2udmFsdWUyCg=="
        },
        {
          "name": "SecretString",
          "type": "string",
          "required": false,
          "description": "新的凭据内容为文本的场景使用该字段，不需要base64编码SecretBinary 和 SecretString 只能一个不为空。",
          "example": "new value"
        }
      ],
      "required": [
        "SecretName",
        "VersionId"
      ]
    }
  ]
}