Configuração das configurações de HTTPS
Função
Essa API é usada para definir configurações HTTPS para um nome de domínio acelerado. Você pode implantar as configurações HTTPS em todos os nós CDN para implementar a aceleração segura.
URI
PUT /v1.0/cdn/domains/{domain_id}/https-info
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
domain_id |
Sim |
String |
Especifica o ID de nome de domínio acelerado. Para obter detalhes, consulte Consulta de detalhes sobre um nome de domínio. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
enterprise_project_id |
Não |
String |
Projeto corporativo ao qual pertence o nome de domínio a ser modificado. Este parâmetro é válido somente quando a função do projeto empresarial está ativada. O valor all indica todos os projetos. Esse parâmetro é obrigatório quando você usa um usuário do IAM para chamar essa API. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Especifica o token do usuário. The token can be obtained by calling the IAM API used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
https |
Sim |
HttpInfoRequestBody object |
Especifica as configurações de HTTPS. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
cert_name |
Sim |
String |
Especifica o nome do certificado. O valor contém de 3 a 32 caracteres. |
|
https_status |
Sim |
Integer |
Especifica se deve ativar o HTTPS. Valores possíveis: 0: desative o HTTPS. O certificado e a chave privada não são necessários. 1: ative o HTTPS e selecione Same as user para Origin Protocol. 2: ative HTTPS e selecione HTTP para Origin Protocol. 3: ative HTTPS e selecione HTTPS para Origin Protocol. O certificado e a chave privada são necessários quando você configura o certificado pela primeira vez. Você precisará especificar o certificado e a chave privada quando habilitar o HTTPS, exceto que você já configurou o certificado e a chave privada antes. |
|
certificate |
Não |
String |
Especifica o corpo do certificado usado pelo protocolo HTTPS. Este parâmetro não é necessário se https_status estiver definido como 0. O valor está no formato PEM. Esse parâmetro é necessário se https_status for definido como 1 ou 2 e você configurar o certificado pela primeira vez. |
|
private_key |
Não |
String |
Especifica a chave privada usada pelo protocolo HTTPS. Este parâmetro não é necessário se https_status estiver definido como 0. O valor está no formato PEM. Esse parâmetro é necessário se https_status for definido como 1 ou 2 e você configurar o certificado pela primeira vez. |
|
http2 |
Não |
Integer |
Especifica se o HTTP/2 deve ser usado. Valores possíveis: 1 (sim) e 0 (não). |
|
certificate_type |
Não |
Integer |
Especifica o tipo de certificado. Valores possíveis: 1 (certificado gerenciado pela Huawei) e 0 (seu próprio certificado). Valor padrão: 0. |
|
force_redirect_https |
Não |
Integer |
Especifica se as solicitações devem ser forçosamente redirecionadas para HTTPS. Valores possíveis: 0 (não) e 1 (sim). É aconselhável usar force_redirect_config para configurar as configurações. |
|
force_redirect_config |
Não |
ForceRedirect object |
Especifica as configurações de redirecionamento forçado. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
switch |
Sim |
Integer |
Especifica se deve habilitar o redirecionamento forçado. Valores possíveis: 1 (ativado) e 0 (desativado). |
|
redirect_type |
Não |
String |
Especifica o protocolo para o qual as solicitações são forçosamente redirecionadas. Valores possíveis: http e https. |
Parâmetros de resposta
Código de estado: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
https |
HttpInfoResponseBody object |
Especifica as configurações de HTTPS. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
https_status |
Integer |
Especifica se deve ativar o HTTPS. Valores possíveis: 0: desative o HTTPS. O certificado e a chave privada não são necessários. 1: habilite HTTPS e selecione Same as user para Origin Protocol no console da CDN. 2: habilite HTTPS e selecione HTTP para Origin Protocol no console da CDN. 3: habilite HTTPS e selecione HTTPS para Origin Protocol no console da CDN. O certificado e a chave privada são necessários quando o HTTPS está habilitado. |
|
cert_name |
String |
Especifica o nome do certificado. O valor contém de 3 a 32 caracteres. |
|
certificate |
String |
Especifica o corpo do certificado. |
|
private_key |
String |
Especifica a chave privada usada pelo protocolo HTTPS. Este parâmetro não é necessário se https_status estiver definido como 0. O valor está no formato de codificação PEM. |
|
certificate_type |
Integer |
Especifica o tipo de certificado. Valores possíveis: 1 (certificado gerenciado pela Huawei) e 0 (seu próprio certificado). |
|
force_redirect_https |
Integer |
Especifica se o redirecionamento forçado está habilitado. Valores possíveis: 1 (sim) e 0 (não). |
|
force_redirect_config |
ForceRedirect object |
Especifica as configurações de redirecionamento forçado. |
|
http2 |
Integer |
Especifica se o HTTP/2 deve ser usado. Valores possíveis: 1 (sim) e 0 (não). |
|
expiration_time |
Long |
Especifica a hora em que o certificado expira. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
switch |
Integer |
Especifica se deve habilitar o redirecionamento forçado. Valores possíveis: 1 (ativado) e 0 (desativado). |
|
redirect_type |
String |
Especifica o protocolo para o qual as solicitações são forçosamente redirecionadas. Valores possíveis: http e https. |
Exemplos de solicitações
PUT https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff8080**********************d71/https-info?enterprise_project_id=0
{
"https" : {
"http2" : 0,
"certificate_type" : 0,
"force_redirect_config" : {
"redirect_type" : "http",
"switch" : 1
},
"force_redirect_https" : 1,
"https_status" : 2,
"cert_name" : "cdn_test_cert",
"certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----",
"private_key" : "-----BEGIN RSA PRIVATE KEY---------END RSA PRIVATE KEY-----"
}
}
Exemplo de respostas
Código de estado: 200
OK
{
"https" : {
"http2" : 0,
"certificate_type" : 0,
"force_redirect_config" : {
"redirect_type" : "http",
"switch" : 1
},
"expiration_time" : 1636183290000,
"force_redirect_https" : 2,
"https_status" : 2,
"cert_name" : "cdn_test_cert",
"certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----",
"private_key" : ""
}
}
Códigos de estado
|
Código de estado |
Descrição |
|---|---|
|
200 |
OK |
Códigos de erro
Consulte Códigos de erro.