DescribeLocationSmb - AWS DataSync
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

DescribeLocationSmb

Fournit des informations sur la configuration d'un emplacement de AWS DataSync transfert pour un serveur de fichiers SMB (Server Message Block).

Syntaxe de la requête

{
   "LocationArn": "string"
}

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

Cette demande accepte les données suivantes au format JSON.

LocationArn

Spécifie le nom de ressource Amazon (ARN) de l'emplacement SMB sur lequel vous souhaitez obtenir des informations.

Type : Chaîne

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Obligatoire : oui

Syntaxe de la réponse

{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosPrincipal": "string",
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   },
   "MountOptions": { 
      "Version": "string"
   },
   "User": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

AgentArns

Les ARNs DataSync agents qui peuvent se connecter à votre serveur de fichiers SMB.

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 8 articles.

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

AuthenticationType

Protocole d'authentification DataSync utilisé pour se connecter à votre serveur de fichiers SMB.

Type : Chaîne

Valeurs valides : NTLM | KERBEROS

CmkSecretConfig

Décrit les informations de configuration d'un secret DataSync géré, tel qu'un Password ou KerberosKeytab DataSync utilisé pour accéder à un emplacement de stockage spécifique, avec un secret géré par le client AWS KMS key.

Type : objet CmkSecretConfig

CreationTime

Heure à laquelle l'emplacement SMB a été créé.

Type : Timestamp

CustomSecretConfig

Décrit les informations de configuration d'un secret géré par le client, tel qu'un Password ou KerberosKeytab qui permet d'accéder à DataSync un emplacement de stockage spécifique, avec un secret géré par le client. AWS KMS key

Type : objet CustomSecretConfig

DnsIpAddresses

Les IPv6 adresses IPv4 ou des serveurs DNS auxquels appartient votre serveur de fichiers SMB. Cet élément ne s'applique que s'AuthenticationTypeil est défini surKERBEROS.

Type : tableau de chaînes

Membres du tableau : nombre maximum de 2 éléments.

Contraintes de longueur : longueur minimale de 7. Longueur maximale de 39

Modèle : \A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z

Domain

Nom du domaine Windows auquel appartient le serveur de fichiers SMB. Cet élément ne s'applique que s'AuthenticationTypeil est défini surNTLM.

Type : Chaîne

Contraintes de longueur : longueur maximale de 253.

Modèle : ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

KerberosPrincipal

Le principal Kerberos autorisé à accéder aux fichiers, aux dossiers et aux métadonnées des fichiers sur votre serveur de fichiers SMB.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : ^.+$

LocationArn

L'ARN de l'emplacement SMB.

Type : Chaîne

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

LocationUri

L'URI de l'emplacement SMB.

Type : Chaîne

Contraintes de longueur : longueur maximale de 4360.

Modèle : ^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$

ManagedSecretConfig

Décrit les informations de configuration d'un secret DataSync géré, tel qu'un Password ou KerberosKeytab DataSync utilisé pour accéder à un emplacement de stockage spécifique. DataSync utilise la clé KMS AWS gérée par défaut pour chiffrer ce secret. AWS Secrets Manager

Type : objet ManagedSecretConfig

MountOptions

Version du protocole SMB DataSync utilisée pour accéder à votre serveur de fichiers SMB.

Type : objet SmbMountOptions

User

L'utilisateur qui peut monter et accéder aux fichiers, aux dossiers et aux métadonnées des fichiers sur votre serveur de fichiers SMB. Cet élément ne s'applique que s'AuthenticationTypeil est défini surNTLM.

Type : Chaîne

Contraintes de longueur : longueur maximale de 104.

Modèle : ^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InternalException

Cette exception est levée lorsqu'une erreur se produit dans le AWS DataSync service.

Code d’état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

Exemples

Exemple

Cet exemple illustre une utilisation de DescribeLocationSmb.

Exemple de demande

{
  "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}

Exemple

Cet exemple illustre une utilisation de DescribeLocationSmb.

Exemple de réponse

{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0bc3b3dc9bbc15145",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-04b3fe3d261a18c8f"
   ],
   "CreationTime":"1532660733.39",
   "Domain":"AMAZON",
   "LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49",
   "LocationUri":"smb://hostname.amazon.com/share",
   "MountOptions":{
      "Version":"SMB3"
   },
   "User":"user-1"
}

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :