CreateHttpsApplicationConfiguration - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Adiciona uma configuração de aplicativo HTTPS a um site.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

esa:CreateHttpsApplicationConfiguration

create

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	integer	Sim	O ID do site. Você pode obter esse ID chamando a API ListSites.	123456****
SiteVersion	integer	Não	A versão da configuração do site. Para sites com o gerenciamento de versões ativado, este parâmetro especifica a versão à qual a configuração se aplica. O valor padrão é 0.	1
RuleName	string	Não	O nome da regra. Este parâmetro é opcional ao adicionar uma configuração global.	rule_example
RuleEnable	string	Não	Especifica se a regra deve ser ativada. Este parâmetro é opcional ao adicionar uma configuração global. Valores válidos: `on`: A regra está ativada. `off`: A regra está desativada.	on
Rule	string	Não	O conteúdo da regra, que é uma expressão condicional que corresponde às solicitações do usuário. Este parâmetro é opcional ao adicionar uma configuração global. Os casos de uso suportados incluem: Para corresponder a todas as solicitações recebidas, defina o valor como `true`. Para corresponder a solicitações específicas, use uma expressão personalizada. Por exemplo: `(http.host eq "video.example.com")`.	(http.host eq \"video.example.com\")
HttpsForce	string	Não	Especifica se o Force HTTPS deve ser ativado. Desativado por padrão. Valores válidos: `on`: Ativado. `off`: Desativado.	on
HttpsForceCode	string	Não	O código de status de redirecionamento a ser usado quando o Force HTTPS está ativado. Valores válidos: `301` `302` `307` `308`	301
AltSvc	string	Não	Especifica se o cabeçalho Alt-Svc deve ser ativado. Desativado por padrão. Valores válidos: `on`: Ativado. `off`: Desativado.	on
AltSvcClear	string	Não	Especifica se o parâmetro `clear` deve ser incluído no cabeçalho Alt-Svc. Desativado por padrão. Valores válidos: `on`: O parâmetro está incluído. `off`: O parâmetro não está incluído.	on
AltSvcPersist	string	Não	Especifica se o parâmetro `persist` deve ser incluído no cabeçalho Alt-Svc. Desativado por padrão. Valores válidos: `on`: O parâmetro está incluído. `off`: O parâmetro não está incluído.	on
AltSvcMa	string	Não	A idade máxima para o cabeçalho Alt-Svc, em segundos. O valor padrão é 86400.	86400
Hsts	string	Não	Especifica se o HTTP Strict Transport Security (HSTS) deve ser ativado. Desativado por padrão. Valores válidos: `on`: Ativado. `off`: Desativado.	on
HstsMaxAge	string	Não	O valor da diretiva `max-age` para o cabeçalho HSTS, em segundos.	3600
HstsIncludeSubdomains	string	Não	Especifica se a diretiva `includeSubDomains` deve ser incluída no cabeçalho HSTS. Desativado por padrão. Valores válidos: `on`: A diretiva está incluída. `off`: A diretiva não está incluída.	on
HstsPreload	string	Não	Especifica se o HSTS Preload deve ser ativado incluindo a diretiva `preload` no cabeçalho HSTS. Desativado por padrão. Valores válidos: `on`: A diretiva está incluída. `off`: A diretiva não está incluída.	on
Sequence	integer	Não	A ordem de execução da regra. Um valor menor indica uma prioridade maior.	1
HttpsSniVerify	string	Não	Especifica se a verificação de Server Name Indication (SNI) deve ser ativada. Desativado por padrão. Valores válidos: `on`: Ativado. `off`: Desativado.	on
HttpsNoSniDeny	string	Não	Especifica se as solicitações de handshake TLS que não incluem um SNI devem ser rejeitadas. Desativado por padrão. Valores válidos: `on`: Rejeita solicitações sem um SNI. `off`: Permite solicitações sem um SNI.	on
HttpsSniWhitelist	string	Não	Especifica a lista de permissões de valores de SNI. Separe vários valores com um espaço.	abc edf

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
RequestId	string	O ID da solicitação.	04F0F334-1335-436C-A1D7-6C044FE73368
ConfigId	integer	O ID da configuração.	352816096987136

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ConfigId": 352816096987136
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter	The specified ArgName is required for this function.	When configuring a specific function, the required parameter is missing.
400	CanNotSetSequence	Non-regular configuration, you cannot set Sequence parameters.	Sequence parameters is not allowed in global configuration.
400	CacheReserveSiteExceedLimit	The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.	The number of sites for which the cache reserve instance bindings exceeds the limit.
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.	Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.
400	SiteConfigLengthExceedLimit	The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.	The size of the site configuration exceeds the limit, and the total size cannot exceed 512K.
400	ConfigConflicts	Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.	The parameter uniqueness check failed. Check for duplicate parameter values.
400	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.	The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.
400	RuleRegexQuotaCheckFailed	When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.	The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.
400	NestedRuleQuotaCheckFailed	The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.	The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.
400	ArgQuotaCheckFailed	The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.	The current plan does not support the configuration of restricted parameters, please check the input parameters.
400	FunctionQuotaCheckFailed	The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.	The current plan does not support the configuration of restricted functions, please check the plan related function description.
400	ConfExceedLimit	The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.	The number of configuration items for the current function has exceeded the upper limit set by the system.
400	ServiceInvokeFailed	The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.	Failed to call the service. Please try again later or contact customer service for details.
400	SpecifiedVersionReadOnly	The specified version number is read-only and cannot be modified.	The specified version number is read-only and cannot be modified.
400	VersionNotValid	The site does not have version management enabled, or the version number passed in does not exist.	The site does not have version management enabled, or the version number passed in does not exist.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.ArgName	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
400	InvalidParameter.ArgValue	Invalid parameter value. Check whether the value format and length meet the requirements.	Invalid parameter value. Check whether the value format and length meet the requirements.
400	InvalidParameter.Configs	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	LockFailed	The system is handling requests you previously submitted. Try again later.	The system is handling requests you previously submitted. Try again later.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	IllegalOperation.VersionManagement	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.
400	QuotaCheckFailed.VersionManagement	Insufficient quota for version management. Contact technical support.	Insufficient quota for version management. Contact technical support.
400	FunctionArgError	Failed to check the configured function parameters.	Failed to check the configured function parameters
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.