v20190923

type Client struct {
	common.Client
}

type CreateSecretRequest struct {
	*tchttp.BaseRequest

	// 凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 凭据版本，查询凭据信息时需要根据SecretName 和 VersionId进行查询，最长64 字节，使用字母、数字或者 - _ . 的组合并且以字母或数字开头。
	VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

	// 描述信息，用于详细描述用途等，最大支持2048字节。
	Description *string `json:"Description,omitempty" name:"Description"`

	// 指定对凭据进行加密的KMS CMK。如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。您也可以指定在同region 下自行创建的KMS CMK进行加密。
	KmsKeyId *string `json:"KmsKeyId,omitempty" name:"KmsKeyId"`

	// 二进制凭据信息base64编码后的明文。SecretBinary 和 SecretString 必须且只能设置一个，最大支持4096字节。
	SecretBinary *string `json:"SecretBinary,omitempty" name:"SecretBinary"`

	// 文本类型凭据信息明文（不需要进行base64编码）。SecretBinary 和 SecretString 必须且只能设置一个，，最大支持4096字节。
	SecretString *string `json:"SecretString,omitempty" name:"SecretString"`
}

type CreateSecretResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 新创建的凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 新创建的凭据版本。
		VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type DeleteSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要删除的凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 指定计划删除日期，单位（天），0（默认）表示立即删除， 1-30 表示预留的天数，超出该日期之后彻底删除。
	RecoveryWindowInDays *uint64 `json:"RecoveryWindowInDays,omitempty" name:"RecoveryWindowInDays"`
}

type DeleteSecretResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 指定删除的凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 凭据删除的日期，unix时间戳。
		DeleteTime *int64 `json:"DeleteTime,omitempty" name:"DeleteTime"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type DeleteSecretVersionRequest struct {
	*tchttp.BaseRequest

	// 指定凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 指定该名称下需要删除的凭据的版本号。
	VersionId *string `json:"VersionId,omitempty" name:"VersionId"`
}

type DeleteSecretVersionResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 凭据版本号。
		VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type DescribeSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要获取凭据详细信息的凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
}

type DescribeSecretResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 凭据描述信息。
		Description *string `json:"Description,omitempty" name:"Description"`

		// 用于加密的KMS CMK ID。
		KmsKeyId *string `json:"KmsKeyId,omitempty" name:"KmsKeyId"`

		// 创建者UIN。
		CreateUin *uint64 `json:"CreateUin,omitempty" name:"CreateUin"`

		// 凭据状态：Enabled、Disabled、PendingDelete
		Status *string `json:"Status,omitempty" name:"Status"`

		// 删除日期，uinx 时间戳，非计划删除状态的凭据为0。
		DeleteTime *uint64 `json:"DeleteTime,omitempty" name:"DeleteTime"`

		// 创建日期。
		CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type DisableSecretRequest struct {
	*tchttp.BaseRequest

	// 指定停用的凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
}

type DisableSecretResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 停用的凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type EnableSecretRequest struct {
	*tchttp.BaseRequest

	// 指定启用凭据的名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
}

type EnableSecretResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 启用的凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type GetRegionsRequest struct {
	*tchttp.BaseRequest
}

type GetRegionsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// region列表。
		Regions []*string `json:"Regions,omitempty" name:"Regions" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type GetSecretValueRequest struct {
	*tchttp.BaseRequest

	// 指定凭据的名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 指定对应凭据的版本号。
	VersionId *string `json:"VersionId,omitempty" name:"VersionId"`
}

type GetSecretValueResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据的名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 该凭据对应的版本号。
		VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

		// 在创建凭据(CreateSecret)时，如果指定的是二进制数据，则该字段为返回结果，并且使用base64进行编码，应用方需要进行base64解码后获取原始数据。SecretBinary和SecretString只有一个不为空。
		SecretBinary *string `json:"SecretBinary,omitempty" name:"SecretBinary"`

		// 在创建凭据(CreateSecret)时，如果指定的是普通文本数据，则该字段为返回结果。SecretBinary和SecretString只有一个不为空。
		SecretString *string `json:"SecretString,omitempty" name:"SecretString"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type GetServiceStatusRequest struct {
	*tchttp.BaseRequest
}

type GetServiceStatusResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// true表示服务已开通，false 表示服务尚未开通。
		ServiceEnabled *bool `json:"ServiceEnabled,omitempty" name:"ServiceEnabled"`

		// 服务不可用类型： 0-未购买，1-正常， 2-欠费停服， 3-资源释放。
		InvalidType *int64 `json:"InvalidType,omitempty" name:"InvalidType"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type ListSecretVersionIdsRequest struct {
	*tchttp.BaseRequest

	// 凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
}

type ListSecretVersionIdsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// VersionId列表。
		// 注意：此字段可能返回 null，表示取不到有效值。
		Versions []*VersionInfo `json:"Versions,omitempty" name:"Versions" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type ListSecretsRequest struct {
	*tchttp.BaseRequest

	// 查询列表的起始位置，以0开始，不设置默认为0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 单次查询返回的最大数量，0或不设置则使用默认值 20。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。
	OrderType *uint64 `json:"OrderType,omitempty" name:"OrderType"`

	// 根据凭据状态进行过滤，默认为0表示查询全部，1 表示查询Enabed 凭据列表，2表示查询Disabled 凭据列表， 3 表示查询PendingDelete 凭据列表。
	State *uint64 `json:"State,omitempty" name:"State"`

	// 根据凭据名称进行过滤，为空表示不过滤。
	SearchSecretName *string `json:"SearchSecretName,omitempty" name:"SearchSecretName"`
}

type ListSecretsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 根据State和SearchSecretName 筛选的凭据总数。
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 返回凭据信息列表。
		SecretMetadatas []*SecretMetadata `json:"SecretMetadatas,omitempty" name:"SecretMetadatas" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type PutSecretValueRequest struct {
	*tchttp.BaseRequest

	// 指定需要增加版本的凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 指定新增加的版本号，最长64 字节，使用字母、数字或者 - _ . 的组合并且以字母或数字开头。
	VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

	// 二进制凭据信息，使用base64编码。SecretBinary 和 SecretString 必须且只能设置一个。
	SecretBinary *string `json:"SecretBinary,omitempty" name:"SecretBinary"`

	// 文本类型凭据信息明文（不需要进行base64编码），SecretBinary 和 SecretString 必须且只能设置一个。
	SecretString *string `json:"SecretString,omitempty" name:"SecretString"`
}

type PutSecretValueResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 新增加的版本号。
		VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type RestoreSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要恢复的凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
}

type RestoreSecretResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type SecretMetadata struct {

	// 凭据名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 凭据的描述信息。
	Description *string `json:"Description,omitempty" name:"Description"`

	// 用于加密凭据的KMS KeyId。
	KmsKeyId *string `json:"KmsKeyId,omitempty" name:"KmsKeyId"`

	// 创建者UIN。
	CreateUin *uint64 `json:"CreateUin,omitempty" name:"CreateUin"`

	// 凭据状态：Enabled、Disabled、PendingDelete
	Status *string `json:"Status,omitempty" name:"Status"`

	// 凭据删除日期，对于status为PendingDelete 的有效，unix时间戳。
	DeleteTime *uint64 `json:"DeleteTime,omitempty" name:"DeleteTime"`

	// 凭据创建时间，unix时间戳。
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// 用于加密凭据的KMS CMK类型，DEFAULT 表示SecretsManager 创建的默认密钥， CUSTOMER 表示用户指定的密钥。
	KmsKeyType *string `json:"KmsKeyType,omitempty" name:"KmsKeyType"`
}

type UpdateDescriptionRequest struct {
	*tchttp.BaseRequest

	// 指定需要更新描述信息的凭据名。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 新的描述信息，最大长度2048个字节。
	Description *string `json:"Description,omitempty" name:"Description"`
}

type UpdateDescriptionResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type UpdateSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要更新凭据内容的名称。
	SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

	// 指定需要更新凭据内容的版本号。
	VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

	// 新的凭据内容为二进制的场景使用该字段，并使用base64进行编码。SecretBinary 和 SecretString 只能一个不为空。
	SecretBinary *string `json:"SecretBinary,omitempty" name:"SecretBinary"`

	// 新的凭据内容为文本的场景使用该字段，不需要base64编码。SecretBinary 和 SecretString 只能一个不为空。
	SecretString *string `json:"SecretString,omitempty" name:"SecretString"`
}

type UpdateSecretResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 凭据名称。
		SecretName *string `json:"SecretName,omitempty" name:"SecretName"`

		// 凭据版本号。
		VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

type VersionInfo struct {

	// 版本号。
	VersionId *string `json:"VersionId,omitempty" name:"VersionId"`

	// 创建时间，unix时间戳。
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`
}