Consulta de nomes de domínio
Função
Essa API é usada para consultar nomes de domínio acelerados.
URI
GET /v1.0/cdn/domains
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
domain_name |
Não |
String |
Especifica o nome de domínio acelerado, que é correspondido de forma difusa. O valor contém de 1 a 255 caracteres. |
business_type |
Não |
String |
Especifica o tipo de serviço do nome de domínio acelerado. Valores possíveis: - web (aceleração de entrega de imagens e arquivos pequenos) - download (aceleração de download de arquivos grandes) - video (aceleração de áudio e vídeo sob demanda) - wholeSite (aceleração de todo o site) |
domain_status |
Não |
String |
Especifica o status do nome de domínio acelerado. Valores possíveis: - online: a CDN foi habilitado para este nome de domínio. - offline: a CDN foi desativada para este nome de domínio. - configuring: a configuração do nome de domínio está em andamento. - *configure_failed: a configuração falha. - checking: o domínio está sendo revisado. - check_failed: o domínio falha na revisão. - deleting: o nome de domínio está sendo excluído. |
service_area |
Não |
String |
Especifica a área coberta pelo serviço de aceleração. Valores possíveis: - mainland_china: China continental. - outside_mainland_china: fora da China continental. - global: global. |
page_size |
Não |
Integer |
Especifica o número de registros em cada página. O valor varia de 1 a 10.000. Se este parâmetro não for definido, o valor padrão 30 é usado. |
page_number |
Não |
Integer |
Especifica o número da página. O valor varia de 1 a 65.535. Se este parâmetro não for definido, o valor padrão 1 é usado. |
enterprise_project_id |
Não |
String |
Projeto corporativo ao qual o recurso pertence. 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âmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
total |
Integer |
Especifica o número total de registros. |
domains |
Array of Domains objects |
Especifica os detalhes do nome de domínio. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
Especifica o ID de nome de domínio acelerado. |
domain_name |
String |
Especifica o nome de domínio acelerado. |
business_type |
String |
Especifica o tipo de serviço do nome de domínio. Valores possíveis: web (aceleração estática), download (aceleração de download), video (aceleração de mídia de streaming) e wholeSite (aceleração de todo o site). |
user_domain_id |
String |
Especifica a ID de domínio do proprietário do nome de domínio. |
domain_status |
String |
Especifica o status do nome de domínio acelerado. Valores possíveis: online (CDN ativado), offline (CDN desativado), configuring (sendo configurado) configure_failed (falha na configuração), checking (sendo revisado), check_failed (rejeitado após revisão) e deleting (sendo excluído). |
cname |
String |
Especifica o registro CNAME do nome de domínio acelerado. |
sources |
Array of Sources objects |
Especifica o nome de domínio ou o endereço IP do servidor de origem. Digite no máximo 10 endereços IP e use vírgulas (,) para separá-los. Apenas endereços IPv4 são permitidos. |
domain_origin_host |
DomainOriginHost object |
Especifica a configuração de recuperação do nome de domínio. |
https_status |
Integer |
Especifica se a aceleração HTTPS está ativada. |
create_time |
Long |
Especifica a hora em que o nome de domínio foi criado. O valor é o número de milissegundos desde a época UNIX (1 de janeiro de 1970). |
modify_time |
Long |
Especifica a hora em que o nome de domínio foi modificado. O valor é o número de milissegundos desde a época UNIX (1 de janeiro de 1970). |
disabled |
Integer |
Especifica se o domínio é proibido. Valores possíveis: 0 (não proibido) e 1 (proibido). |
locked |
Integer |
Especifica se o domínio está bloqueado. Valores possíveis: 0 (não bloqueado) e 1 (bloqueado). |
auto_refresh_preheat |
Integer |
Especifica se a atualização automática e o pré-aquecimento estão ativados. Valores possíveis: 0 (desativado) e 1 (ativado). |
service_area |
String |
Especifica o escopo do serviço CDN. Valores possíveis: mainland_china (China continental), outside_mainland_china (fora da China continental) e global (global). |
range_status |
String |
Especifica se a recuperação baseada em intervalo está ativada. |
follow_status |
String |
Especifica se a recuperação de redirecionamento está ativada. |
origin_status |
String |
Especifica se a recuperação de conteúdo está desabilitada. |
banned_reason |
String |
Especifica o motivo da desativação do nome de domínio. |
locked_reason |
String |
Especifica o motivo do bloqueio do nome de domínio. |
enterprise_project_id |
String |
ID do projeto empresarial ao qual o recurso pertence. Este parâmetro é válido somente quando a função do projeto empresarial está ativada. Se este parâmetro não for especificado, o projeto padrão será consultado. Esse parâmetro é obrigatório quando você usa um usuário do IAM para chamar essa API. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
domain_id |
String |
ID do nome de domínio. |
ip_or_domain |
String |
Especifica o endereço IP ou nome de domínio do servidor de origem. |
origin_type |
String |
Especificado o tipo do servidor de origem. Valores possíveis: ipaddr (endereço IP do servidor de origem), domain (nome de domínio do servidor de origem), e obs_bucket (nome de domínio de um bucket do OBS). |
active_standby |
Integer |
Especifica se o servidor de origem está ativo ou em espera. Valores possíveis: 1 (ativo) e 0 (em espera). Um servidor de origem ativo é obrigatório, enquanto um servidor de origem em espera é opcional. Um bucket do OBS não tem um servidor de origem em espera. |
enable_obs_web_hosting |
Integer |
Especifica se a hospedagem estática está ativada para um bucket do OBS. Valores possíveis: 0 (desativado) e 1 (ativado). Este parâmetro é passado somente quando origin_type é definido como obs_bucket. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
domain_id |
String |
Especifica a ID do nome de domínio. Para obter detalhes, consulte Consulta de detalhes sobre um nome de domínio. |
origin_host_type |
String |
Especifica o tipo do host de recuperação. |
customize_domain |
String |
Especifica o nome de domínio personalizado do host de recuperação. |
Exemplos de solicitações
GET https://cdn.myhuaweicloud.com/v1.0/cdn/domains?domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0
Exemplo de respostas
Código de estado: 200
OK
{ "total" : 1, "domains" : [ { "sources" : [ { "origin_type" : "ipaddr", "ip_or_domain" : "10.62.53.75", "active_standby" : 1 } ], "cname" : "www.example.com.c.test.com", "id" : "ab1234a*********************g56", "user_domain_id" : "1e234********************441", "domain_name" : "www.example.com", "business_type" : "web", "service_area" : "mainland_china", "domain_status" : "online", "https_status" : 0, "create_time" : 1516861994806, "modify_time" : 1532405346365, "domain_origin_host" : { "domain_id" : "ab1234a*********************g56", "origin_host_type" : "customize", "customize_domain" : "www.xxxx.com" }, "disabled" : 0, "locked" : 0, "range_status" : "off", "follow_status" : "off", "origin_status" : "on", "auto_refresh_preheat" : 0 } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
Códigos de erro
Consulte Códigos de erro.