DescribeApiGroup - API Gateway: Central de Documentação do Alibaba Cloud

Consulta um grupo de API especificado, incluindo o nome de domínio de segundo nível gerado pelo sistema, nomes de domínio personalizados e informações do certificado SSL.

Descrição da operação

Esta operação é destinada a provedores de API.

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

apigateway:DescribeApiGroup

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	string	Sim	O ID do grupo de API. Este ID é gerado pelo sistema e é globalmente único.	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	Não	As tags do objeto. Você pode especificar múltiplas tags.	Key， Value
	object	Não	Uma tag.
Key	string	Não	A chave da tag.	appname
Value	string	Não	O valor da tag.	test_app

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Status	string	O status do grupo. NORMAL: O grupo está normal. DELETE: O grupo foi excluído.	NORMAL
CompatibleFlags	string	Uma lista de tags associadas. Múltiplas tags são separadas por vírgulas (,).	depart:dep1
BasePath	string	O caminho raiz da API.	/qqq
Ipv6Status	string	O status do IPv6.	UNBIND
UserLogConfig	string	As configurações de log do usuário.	{\"requestBody\":true,\"responseBody\":true,\"queryString\":\"test\",\"requestHeaders\":\"test\",\"responseHeaders\":\"test\",\"jwtClaims\":\"test\"}
CustomerConfigs	string	A lista de itens de configuração personalizados.	removeResponseServerHeader
RequestId	string	O ID da solicitação.	03442A3D-3B7D-434C-8A95-A5FEB989B519
Description	string	A descrição do grupo de API.	New weather informations.
HttpsPolicy	string	A política HTTPS.	HTTPS2_TLS1_0
SubDomain	string	O nome de domínio de segundo nível atribuído ao grupo pelo sistema.	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	A hora de criação, em UTC.	2016-08-01T06:53:02Z
DefaultDomain	string	O nome de domínio padrão.	mkt.api.gaore.com
CmsMonitorGroup	string	O grupo de aplicação do Cloud Monitor.	217008423
BillingStatus	string	O status de faturamento. NORMAL: O faturamento está normal. LOCKED: O grupo está bloqueado devido a pagamento em atraso.	NORMAL
TrafficLimit	integer	O número máximo de consultas por segundo (QPS) para o grupo. O valor padrão é 500. Para aumentar o limite, envie uma solicitação.	500
PassthroughHeaders	string	Os cabeçalhos de passagem direta.	eagleeye-rpcid,x-b3-traceid
InstanceId	string	O ID da instância.	apigateway-cn-v6419k43xxxxx
VpcDomain	string	O nome de domínio da VPC.	e4**7151954acbd9f7***1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceType	string	O tipo da instância. CLASSIC_SHARED: uma instância compartilhada na rede clássica. VPC_SHARED: uma instância compartilhada em uma VPC. VPC_DEDICATED: uma instância dedicada em uma VPC.	VPC_SHARED
CustomTraceConfig	string	A configuração de rastreamento personalizada.	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	A região onde o grupo está localizado.	cn-hangzhou
ModifiedTime	string	A hora da última modificação, em UTC.	2016-08-01T06:54:32Z
GroupId	string	O ID do grupo de API. Este ID é gerado pelo sistema e é globalmente único.	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	O nome do grupo de API.	NewWeather
IllegalStatus	string	O status de bloqueio devido a atividades ilegais. NORMAL: O grupo está normal. LOCKED: O grupo está bloqueado devido a atividades ilegais.	NORMAL
VpcSlbIntranetDomain	string	O nome de domínio privado da instância SLB da VPC.	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object
DomainItem	array<object>	As informações sobre o nome de domínio personalizado.
	object	As informações sobre o nome de domínio personalizado.
BindStageName	string	The name of the environment to which the domain name is bound.	TEST
DomainLegalStatus	string	The validity status of the domain name. Valid values: NORMAL: The domain name is valid. ABNORMAL: The domain name is invalid. This status affects API calls. Resolve the issue as soon as possible.	ABNORMAL
CertificateName	string	The name of the SSL certificate.	myCertificate
CustomDomainType	string	The type of the custom domain name.	intranet
DomainCNAMEStatus	string	The CNAME resolution status of the domain name. Valid values: RESOLVED: The domain name is resolved. UNRESOLVED: The domain name is not resolved.	RESOLVED
WildcardDomainPatterns	string	The wildcard domain name pattern.	[\"{test}.test.com\"]
DomainBindingStatus	string	The binding status of the custom domain name. Valid values: BINDING: The domain name is being bound. BOUND: The domain name is bound.	BINDING
DomainName	string	The domain name.	api.demo.com
DomainRemark	string	The remarks about the domain name, such as the cause of an exception.	The domain name is not registered.
DomainWebSocketStatus	string	The status of the domain name that is used for WebSocket connections.	CLOSE
CertificateId	string	The ID of the SSL certificate. This ID is automatically generated by the system and is unique.	6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttps	boolean	Indicates whether HTTP requests are redirected to HTTPS.	false
CertificateValidStart	integer	The time when the certificate becomes valid.	1689043476000
CertificateValidEnd	integer	The time when the certificate expires.	2635123476000
BindStageAlias	string	The alias of the environment to which the domain name is bound.	TEST1
SslVerifyDepth	integer	The certificate verification depth.	2
SslOcspEnable	boolean	Indicates whether Online Certificate Status Protocol (OCSP) validation is supported.	true
SslOcspCacheEnable	boolean	Indicates whether OCSP caching is supported.	true
ClientCertSDnPassThrough	boolean	Indicates whether the `ssl_client_s_dn` value in the certificate is passed to the backend service through the `X-Client-S-Dn` header.	true
StageItems	object
StageInfo	array<object>	As informações sobre o ambiente.
	object	As informações sobre o ambiente.
StageId	string	The environment ID.	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	The environment name.	TEST
Description	string	The description of the environment.	MYTEST
CloudMarketCommodity	boolean	O produto do Alibaba Cloud Marketplace.	false
DedicatedInstanceType	string	O tipo da instância dedicada na qual o grupo está localizado. Instância dedicada conectada à VPC: `vpc_connect` Instância dedicada legada: `normal`	normal
MigrationStatus	string	O status da tarefa de migração do grupo para outra instância. `Running` `Success` `Fail`	Fail
MigrationError	string	A causa da falha de migração. Este parâmetro é retornado quando o valor de MigrationStatus é `Fail`.	The current instance conflicts with the target instance.
DisableInnerDomain	boolean	Indica se o acesso pela internet através do nome de domínio de segundo nível está desativado. `true`: O acesso pela internet através do nome de domínio de segundo nível está desativado. `false`: O acesso pela internet através do nome de domínio de segundo nível é permitido.	false
CustomAppCodeConfig	string	A configuração personalizada de AppCode.	{"location":"HEADER","name":"myAppCodeHeader"}

Exemplos

Resposta de sucesso

JSON formato

{
  "Status": "NORMAL",
  "CompatibleFlags": "depart:dep1",
  "BasePath": "/qqq",
  "Ipv6Status": "UNBIND",
  "UserLogConfig": "{\\\"requestBody\\\":true,\\\"responseBody\\\":true,\\\"queryString\\\":\\\"test\\\",\\\"requestHeaders\\\":\\\"test\\\",\\\"responseHeaders\\\":\\\"test\\\",\\\"jwtClaims\\\":\\\"test\\\"}",
  "CustomerConfigs": "removeResponseServerHeader",
  "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B519",
  "Description": "New weather informations.",
  "HttpsPolicy": "HTTPS2_TLS1_0",
  "SubDomain": "27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
  "CreatedTime": "2016-08-01T06:53:02Z",
  "DefaultDomain": "mkt.api.gaore.com",
  "CmsMonitorGroup": "217008423",
  "BillingStatus": "NORMAL",
  "TrafficLimit": 500,
  "PassthroughHeaders": "eagleeye-rpcid,x-b3-traceid",
  "InstanceId": "apigateway-cn-v6419k43xxxxx",
  "VpcDomain": "e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com",
  "InstanceType": "VPC_SHARED",
  "CustomTraceConfig": "{\\\"parameterLocation\\\":\\\"HEADER\\\",\\\"parameterName\\\":\\\"traceId\\\"}",
  "RegionId": "cn-hangzhou",
  "ModifiedTime": "2016-08-01T06:54:32Z",
  "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  "GroupName": "NewWeather",
  "IllegalStatus": "NORMAL",
  "VpcSlbIntranetDomain": "257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com",
  "CustomDomains": {
    "DomainItem": [
      {
        "BindStageName": "TEST",
        "DomainLegalStatus": "ABNORMAL",
        "CertificateName": "myCertificate",
        "CustomDomainType": "intranet",
        "DomainCNAMEStatus": "RESOLVED",
        "WildcardDomainPatterns": "[\\\"{test}.test.com\\\"]",
        "DomainBindingStatus": "BINDING",
        "DomainName": "api.demo.com",
        "DomainRemark": "The domain name is not registered.",
        "DomainWebSocketStatus": "CLOSE",
        "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "IsHttpRedirectToHttps": false,
        "CertificateValidStart": 1689043476000,
        "CertificateValidEnd": 2635123476000,
        "BindStageAlias": "TEST1",
        "SslVerifyDepth": 2,
        "SslOcspEnable": true,
        "SslOcspCacheEnable": true,
        "ClientCertSDnPassThrough": true
      }
    ]
  },
  "StageItems": {
    "StageInfo": [
      {
        "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
        "StageName": "TEST",
        "Description": "MYTEST"
      }
    ]
  },
  "CloudMarketCommodity": false,
  "DedicatedInstanceType": "normal",
  "MigrationStatus": "Fail",
  "MigrationError": "The current instance conflicts with the target instance.",
  "DisableInnerDomain": false,
  "CustomAppCodeConfig": "{\"location\":\"HEADER\",\"name\":\"myAppCodeHeader\"}"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.