DescribeLocationSmb - AWS DataSync

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DescribeLocationSmb

Fornece detalhes sobre como um local AWS DataSync de transferência para um servidor de arquivos SMB (Server Message Block) é configurado.

Sintaxe da solicitação

{ "LocationArn": "string" }

Parâmetros da solicitação

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

LocationArn

Especifica o nome do recurso da Amazon (ARN) do local SMB sobre o qual você deseja informações.

Tipo: string

Restrições de tamanho: tamanho máximo de 128.

Padrão: ^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}$

Obrigatório: sim

Sintaxe da resposta

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

Elementos de resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

AgentArns

O ARNs dos DataSync agentes que podem se conectar ao seu servidor de arquivos SMB.

Tipo: matriz de strings

Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.

Restrições de Tamanho: Tamanho máximo de 128.

Padrão: ^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

O protocolo de autenticação DataSync usado para se conectar ao seu servidor de arquivos SMB.

Tipo: string

Valores válidos: NTLM | KERBEROS

CmkSecretConfig

Descreve as informações de configuração DataSync de um segredo gerenciado, como um Password ou KerberosKeytab que é DataSync usado para acessar um local de armazenamento específico, com um gerenciado pelo cliente AWS KMS key.

Tipo: objeto CmkSecretConfig

CreationTime

O horário em que o local do SMB foi criado.

Tipo: carimbo de data/hora

CustomSecretConfig

Descreve as informações de configuração de um segredo gerenciado pelo cliente, como um Password ou KerberosKeytab que é DataSync usado para acessar um local de armazenamento específico, com um segredo gerenciado pelo cliente. AWS KMS key

Tipo: objeto CustomSecretConfig

DnsIpAddresses

Os IPv6 endereços IPv4 ou dos servidores DNS aos quais seu servidor de arquivos SMB pertence. Esse elemento se aplica somente se AuthenticationType estiver definido como KERBEROS.

Tipo: matriz de strings

Membros da matriz: número máximo de 2 itens.

Restrições de comprimento: comprimento mínimo de 7. Comprimento máximo de 39.

Padrão: \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

O nome do domínio do Windows ao qual o servidor de arquivos SMB pertence. Esse elemento se aplica somente se AuthenticationType estiver definido como NTLM.

Tipo: string

Restrições de tamanho: tamanho máximo de 253.

Padrão: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

KerberosPrincipal

A entidade principal Kerberos que tem permissão para acessar os arquivos, pastas e metadados de arquivos no servidor de arquivos SMB.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.

Padrão: ^.+$

LocationArn

O ARN do local SMB.

Tipo: string

Restrições de tamanho: tamanho máximo de 128.

Padrão: ^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

O URI do local SMB.

Tipo: string

Restrições de tamanho: tamanho máximo de 4.360.

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

ManagedSecretConfig

Descreve as informações de configuração DataSync de um segredo gerenciado, como um Password ou KerberosKeytab que é DataSync usado para acessar um local de armazenamento específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager

Tipo: objeto ManagedSecretConfig

MountOptions

A versão do protocolo SMB DataSync usada para acessar seu servidor de arquivos SMB.

Tipo: objeto SmbMountOptions

User

O usuário que pode montar e acessar os arquivos, pastas e metadados de arquivos no servidor de arquivos SMB. Esse elemento se aplica somente se AuthenticationType estiver definido como NTLM.

Tipo: string

Restrições de tamanho: tamanho máximo de 104.

Padrão: ^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

InternalException

Essa exceção é lançada quando ocorre um erro no serviço AWS DataSync .

Código de status HTTP: 500

InvalidRequestException

Essa exceção é lançada quando o cliente envia uma solicitação malformada.

Código de status HTTP: 400

Exemplos

Exemplo

Este exemplo ilustra um uso do. DescribeLocationSmb

Exemplo de solicitação

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

Exemplo

Este exemplo ilustra um uso do. DescribeLocationSmb

Resposta da amostra

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

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: