DescribeApiGroup - - Centre de documentation Alibaba Cloud

Consulte un groupe d'API spécifié, y compris son nom de domaine de second niveau généré par le système, ses noms de domaine personnalisés et les informations de son certificat SSL.

Description de l'opération

Cette opération est destinée aux fournisseurs d'API.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

apigateway:DescribeApiGroup

get

*ApiGroup

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GroupId	string	Oui	L'identifiant du groupe d'API. Cet identifiant est généré par le système et est globalement unique.	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	Non	Les balises de l'objet. Vous pouvez spécifier plusieurs balises.	Clé, Valeur
	object	Non	Une balise.
Key	string	Non	La clé de la balise.	appname
Value	string	Non	La valeur de la balise.	test_app

Éléments de réponse

Élément	Type	Description	Exemple
	object
Status	string	L'état du groupe.	NORMAL
CompatibleFlags	string	Une liste de balises associées. Plusieurs balises sont séparées par des virgules (,).	depart:dep1
BasePath	string	Le chemin racine de l'API.	/qqq
Ipv6Status	string	L'état IPv6.	UNBIND
UserLogConfig	string	Les paramètres des journaux utilisateur.	{\"requestBody\":true,\"responseBody\":true,\"queryString\":\"test\",\"requestHeaders\":\"test\",\"responseHeaders\":\"test\",\"jwtClaims\":\"test\"}
CustomerConfigs	string	La liste des éléments de configuration personnalisés.	removeResponseServerHeader
RequestId	string	L'identifiant de la requête.	03442A3D-3B7D-434C-8A95-A5FEB989B519
Description	string	La description du groupe d'API.	Nouvelles informations météorologiques
HttpsPolicy	string	La stratégie HTTPS.	HTTPS2_TLS1_0
SubDomain	string	Le nom de domaine de second niveau attribué au groupe par le système.	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	L'heure de création, en UTC.	2016-08-01T06:53:02Z
DefaultDomain	string	Le nom de domaine par défaut.	mkt.api.gaore.com
CmsMonitorGroup	string	Le groupe d'applications Cloud Monitor.	217008423
BillingStatus	string	L'état de la facturation.	NORMAL
TrafficLimit	integer	Le nombre maximal de requêtes par seconde (QPS) pour le groupe. La valeur par défaut est 500. Pour augmenter cette limite, soumettez une demande.	500
PassthroughHeaders	string	Les en-têtes de transmission.	eagleeye-rpcid,x-b3-traceid
InstanceId	string	L'identifiant de l'instance.	apigateway-cn-v6419k43xxxxx
VpcDomain	string	Le nom de domaine du VPC.	e4**7151954acbd9f7***1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceType	string	Le type d'instance.	VPC_SHARED
CustomTraceConfig	string	La configuration de trace personnalisée.	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	La région où se trouve le groupe.	cn-hangzhou
ModifiedTime	string	L'heure de la dernière modification, en UTC.	2016-08-01T06:54:32Z
GroupId	string	L'identifiant du groupe d'API. Cet identifiant est généré par le système et est globalement unique.	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	Le nom du groupe d'API.	NewWeather
IllegalStatus	string	L'état de verrouillage dû à des activités illégales.	NORMAL
VpcSlbIntranetDomain	string	Le nom de domaine privé de l'instance SLB du VPC.	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object
DomainItem	array<object>	Les informations sur le nom de domaine personnalisé.
	object	Les informations sur le nom de domaine personnalisé.
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>	Les informations sur l'environnement.
	object	Les informations sur l'environnement.
StageId	string	The environment ID.	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	The environment name.	TEST
Description	string	The description of the environment.	MYTEST
CloudMarketCommodity	boolean	Le produit de la place de marché Alibaba Cloud.	false
DedicatedInstanceType	string	Le type d'instance dédiée dans laquelle se trouve le groupe.	normal
MigrationStatus	string	L'état de la tâche de migration du groupe vers une autre instance.	Fail
MigrationError	string	La cause de l'échec de la migration. Ce paramètre est renvoyé lorsque la valeur de MigrationStatus est Fail.	L'instance actuelle est en conflit avec l'instance cible
DisableInnerDomain	boolean	Indique s'il faut désactiver l'accès depuis Internet via le nom de domaine de second niveau.	false
CustomAppCodeConfig	string	La configuration AppCode personnalisée.	{"location":"HEADER","name":"myAppCodeHeader"}

Exemples

JSON format

{
  "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\"}"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.