DescribeImageComponents - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les détails d'un ou plusieurs composants d'image.

Description de l'opération

Vous pouvez définir NextToken sur la valeur de NextToken renvoyée par l'appel précédent à DescribeImageComponents, et définir MaxResults pour spécifier le nombre maximal d'entrées par page.

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.

ecs:DescribeImageComponents

get

*ImageComponent

acs:ecs:{#regionId}:{#accountId}:imagecomponent/*

*ImageComponent

acs:ecs:{#regionId}:{#accountId}:imagecomponent/{#imagecomponentId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Si vous utilisez ce paramètre pour filtrer les ressources, le nombre de ressources ne peut pas dépasser 1 000. Remarque Le filtrage par le groupe de ressources par défaut n'est pas pris en charge.	rg-bp67acfmxazb4p****
Tag	array<object>	Non	Les balises.
	object	Non
Key	string	Non	La clé de la balise. Valeurs valides de N : 1 à 20.	TestKey
Value	string	Non	La valeur de la balise. Valeurs valides de N : 1 à 20.	TestValue
Name	string	Non	L'identifiant de la région. Vous pouvez appeler DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
NextToken	string	Non	L'identifiant du groupe de ressources. Si vous utilisez ce paramètre pour filtrer les ressources, le nombre de ressources ne peut pas dépasser 1 000. Remarque Le filtrage par le groupe de ressources par défaut n'est pas pris en charge.	rg-bp67acfmxazb4p****
MaxResults	integer	Non	Le nom du composant d'image. Seule la correspondance exacte est prise en charge.	testComponent
Owner	string	Non	Le jeton de pagination. Définissez ce paramètre sur la valeur de NextToken renvoyée par l'appel précédent. Vous n'avez pas besoin de définir ce paramètre pour la première requête.	AAAAAdDWBF2****
ImageComponentId	array	Non	Le nombre maximal d'entrées par page pour la pagination. Valeurs valides : 1 à 500. Valeur par défaut : 50.	50
	string	Non	The ID of the image component to query. Valid values of N: 1 to 20.	ic-bp67acfmxazb4p****
ComponentType	string	Non	Le type de composant d'image. Valeurs valides : SELF : composants d'image personnalisés que vous avez créés. ALIYUN : composants système fournis par Alibaba Cloud.	SELF
SystemType	string	Non	L'identifiant du composant d'image à consulter. Valeurs valides de N : 1 à 20.	ic-bp67acfmxazb4p****
ComponentVersion	string	Non	Le type de composant. Valeurs valides : Build Test.	Build
		Non	Le système d'exploitation pris en charge par le composant. Valeurs valides : Linux Windows.	Linux
		Non	Le numéro de version du composant au format major.minor.patch. Chaque partie doit être un entier non négatif. Vous pouvez également utiliser le caractère générique () pour remplacer une partie afin d'effectuer une correspondance approximative. Remarque* Ce paramètre ne prend effet que lorsque Name est spécifié.	1.0.*

Éléments de réponse

Élément	Type	Description	Exemple
	object
NextToken	string	Le jeton de pagination renvoyé dans cet appel. Pour plus d'informations sur l'utilisation de ce jeton, reportez-vous à la description de l'opération.	AAAAAdDWBF2****
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Le nombre total de composants d'image renvoyés.	1
MaxResults	integer	Le nombre maximal d'entrées par page pour la pagination.	50
ImageComponent	object
ImageComponentSet	array<object>	La liste des détails des composants d'image.
	array<object>
CreationTime	string	The time when the component was created.	2020-11-24T06:00:00Z
Description	string	The description.	This is description.
SystemType	string	The operating system supported by the component.	Linux
ImageComponentId	string	The image component ID.	ic-bp67acfmxazb4p****
ComponentType	string	The component type.	Build
ResourceGroupId	string	The resource group ID.	rg-bp67acfmxazb4p****
Name	string	The component name.	testComponent
Content	string	The component content.	Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
Owner	string	The image component type. Valid values: SELF: custom image components that you created. ALIYUN: system components provided by Alibaba Cloud.	SELF
Tags	object
Tag	array<object>	The list of tag key-value pairs.
	object
TagValue	string	The tag value.	TestValue
TagKey	string	The tag key.	TestKey
ComponentVersion	string	The component version number.	1.0.0
Parameters	object
Parameter	array<object>	The list of parameters included in the image component.
	object
Name	string	The parameter name.	paramName
Type	string	The parameter type. Valid values: String Number Boolean	String
DefaultValue	string	The default value of the parameter.	paramDefaultValue

Exemples

JSON format

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImageComponent": {
    "ImageComponentSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "Description": "This is description.",
        "SystemType": "Linux",
        "ImageComponentId": "ic-bp67acfmxazb4p****",
        "ComponentType": "Build",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Name": "testComponent",
        "Content": "Tasks:\n  - Name: HelloWorld\n    Action: RunShellCommand\n    Properties:\n      commandContent: echo hello world\n",
        "Owner": "SELF",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ComponentVersion": "1.0.0",
        "Parameters": {
          "Parameter": [
            {
              "Name": "paramName",
              "Type": "String",
              "DefaultValue": "paramDefaultValue"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter.Owner	The specified parameter \"Owner\" is not valid.
400	InvalidImageComponentIdSize.ExceededMaxNumber	%s	The specified parameter value is invalid. For more information, see the actual return result of the %s placeholder in the error message.
400	InvalidSystemType.NotSupportedValue	%s.	The specified SystemType is invalid.
400	InvalidComponentType.NotSupportedValue	%s.	The specified ComponentType is invalid.
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.	The specified ComponentVersion is invalid.
403	Invalid.NextToken	The specified NextToken is not valid.

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

Notes de version

Consultez Notes de version pour la liste complète.