DescribeCloudAssistantSettings - Elastic Compute Service - Centre de documentation Alibaba Cloud

Présente un aperçu de la configuration du service Cloud Assistant.

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:DescribeCloudAssistantSettings

list

*ServiceSettings

acs:ecs:{#regionId}:{#accountId}:servicesettings/{#servicesettingId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SettingType	array	Oui	Les types de configurations de service à interroger.
	string	Non	Un type de configuration de service. Valeurs valides : SessionManagerDelivery : contrôle la remise des enregistrements d'opérations de session. InvocationDelivery : contrôle la remise des enregistrements d'exécution de commandes. AgentUpgradeConfig : contrôle les mises à niveau de l'agent Cloud Assistant. SessionManagerConfig : contrôle les paramètres de SessionManager pour Cloud Assistant.	SessionManagerDelivery
RegionId	string	Oui	L'identifiant de la région.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigs	object
OssDeliveryConfig	array<object>	Une liste de configurations de remise OSS.
	object	Une configuration de remise OSS.
EncryptionType	string	The OSS encryption type. Valid values: Inherit: inherits the encryption setting of the bucket. OssManaged: OSS-managed encryption. KMS: KMS-based encryption.	Inherit
EncryptionAlgorithm	string	The OSS encryption algorithm. Valid values: AES256 SM4	AES256
DeliveryType	string	The delivery type. Valid values: SessionManager: session operation logs. Invocation: task execution logs.	SessionManager
Enabled	boolean	Indicates whether delivery to OSS is enabled.	false
BucketName	string	The name of the OSS bucket.	example-bucket
Prefix	string	The directory prefix of the OSS bucket.	sessionmanager/audit
EncryptionKeyId	string	The ID of the customer master key (CMK) when the encryption type is set to KMS.	a807****7a70e
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	Une liste de configurations de remise SLS.
	object	La configuration de remise SLS.
DeliveryType	string	The delivery type. Valid values: SessionManager: session operation logs. Invocation: task execution logs.	SessionManager
LogstoreName	string	The name of the SLS Logstore.	example-logstore
Enabled	boolean	Indicates whether delivery to SLS is enabled.	false
ProjectName	string	The name of the SLS project.	example-project
AgentUpgradeConfig	object	La configuration de mise à niveau de l'agent Cloud Assistant.
Enabled	boolean	Indique si les paramètres de mise à niveau personnalisés de l'agent sont activés. Si ce paramètre est défini sur `false` ou n'est pas spécifié, l'agent tente de se mettre à niveau toutes les 30 minutes par défaut.	true
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	The list of allowed upgrade time windows.
	string	The list of allowed upgrade time windows.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	Le fuseau horaire pour les plages horaires de mise à niveau autorisées.	Asia/Shanghai
BootstrapUpgrade	boolean	Indique si l'agent Cloud Assistant vérifie et effectue une mise à niveau au démarrage.	true
DisableUpgrade	boolean	Indique si les mises à niveau automatiques de l'agent Cloud Assistant doivent être désactivées.	true
ResourceUsageConfig	object	La configuration d'utilisation des ressources de Cloud Assistant.
CpuLimit	integer	La limite maximale d'utilisation du processeur pour le processus principal de l'agent Cloud Assistant.	20
MemoryLimit	string	La limite maximale d'utilisation de la mémoire pour le processus principal de l'agent Cloud Assistant.	35MB
OverloadLimit	integer	Le nombre maximal de fois consécutives où l'utilisation du processeur ou de la mémoire peut dépasser les limites spécifiées. Si ce nombre est atteint, l'agent Cloud Assistant s'arrête.	3
LogFileCountLimit	integer	Le nombre maximal de fichiers journaux de Cloud Assistant à conserver.	30
LogSizeLimit	string	La limite de taille pour chaque fichier journal de Cloud Assistant.	100MB
KeepScriptFile	boolean	Indique si le fichier de script doit être conservé dans le répertoire de Cloud Assistant après la fin de l'exécution de la commande.	false
SessionManagerConfig	object	La configuration de Session Manager pour Cloud Assistant.
SessionManagerEnabled	boolean	Indique si Session Manager est activé. Valeurs valides : `true` : activé. `false` : désactivé. Remarque : Ce paramètre prend effet dans toutes les régions.	true

Exemples

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "OssDeliveryConfigs": {
    "OssDeliveryConfig": [
      {
        "EncryptionType": "Inherit",
        "EncryptionAlgorithm": "AES256",
        "DeliveryType": "SessionManager",
        "Enabled": false,
        "BucketName": "example-bucket",
        "Prefix": "sessionmanager/audit",
        "EncryptionKeyId": "a807****7a70e"
      }
    ]
  },
  "SlsDeliveryConfigs": {
    "SlsDeliveryConfig": [
      {
        "DeliveryType": "SessionManager",
        "LogstoreName": "example-logstore",
        "Enabled": false,
        "ProjectName": "example-project"
      }
    ]
  },
  "AgentUpgradeConfig": {
    "Enabled": true,
    "AllowedUpgradeWindows": {
      "AllowedUpgradeWindow": [
        "[\n\"02:00-03:00\",\n\"05:00-06:00\"\n]"
      ]
    },
    "TimeZone": "Asia/Shanghai",
    "BootstrapUpgrade": true,
    "DisableUpgrade": true
  },
  "ResourceUsageConfig": {
    "CpuLimit": 20,
    "MemoryLimit": "35MB",
    "OverloadLimit": 3,
    "LogFileCountLimit": 30,
    "LogSizeLimit": "100MB",
    "KeepScriptFile": false
  },
  "SessionManagerConfig": {
    "SessionManagerEnabled": true
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter.SettingType	The specified parameter SettingType is not valid.	The specified parameter SettingType is illegal.
500	InternalError	An error occurred when you dispatched the request.	An error occurred while sending the request, please try again later.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	The region information is invalid.

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

Notes de version

Consultez Notes de version pour la liste complète.