1.DiscoveryREST
1.1GET /v2/search/attribute
Request Parameters
Example
1.2GET /v2/search/basic
Request Parameters
name | type | description | constraints |
---|---|---|---|
classification | query | limit the result to only entities tagged with the given classification or or its sub-types | |
excludeDeletedEntities | query | boolean | |
limit | query | limit the result set to only include the specified number of entries | int |
offset | query | start offset of the result set (useful for pagination) | int |
query | query | Fulltext query | |
typeName | query | limit the result to only entities of specified type or its sub-types |
Example
[root@testkafka-01 bin]# curl -u admin:admin -X GET --header 'Accept: application/json' 'http://testkafka-01:21000/api/atlas/v2/search/basic?query=test&typeName=hive_table'
{"queryType":"BASIC","searchParameters":{"query":"test","typeName":"hive_table","excludeDeletedEntities":false,"includeClassificationAttributes":false,"includeSubTypes":true,"includeSubClassifications":true,"limit":100,"offset":0},"queryText":"test","entities":[{"typeName":"hive_table","attributes":{"owner":"root","createTime":1593328620000,"qualifiedName":"goudan.test@atlas-cluster","name":"test"},"guid":"52361402-2485-4760-9da8-6b73721e2322","status":"ACTIVE","displayText":"test","classificationNames":[],"meaningNames":[],"meanings":[]}]
2.EntityREST
2.1GET /v2/entity/guid/{guid}
Request Parameters
name | type | description | default | constraints |
---|---|---|---|---|
guid | path | GUID for the entity | ||
ignoreRelationships | query | false | boolean | |
minExtInfo | query | false | boolean |
Example
[root@testkafka-01 bin]# curl -u admin:admin -X GET 'http://testkafka-01:21000/api/atlas/v2/entity/guid/52361402-2485-4760-9da8-6b73721e2322'
{"referredEntities":{"0f022caa-b9e9-40f5-b2c2-8df4f8e25ebd":{"typeName":"hive_column","attributes":{"owner":"root","replicatedTo":null,"replicatedFrom":null,"qualifiedName":"goudan.test.id@atlas-cluster","name":"id","description":null,"comment":null,"position":0,"type":"int","table":{"guid":"52361402-2485-4760-9da8-6b73721e2322","typeName":"hive_table"}},"guid":"0f022caa-b9e9-40f5-b2c2-8df4f8e25ebd","status":"ACTIVE","createdBy":"root","updatedBy":"root","createTime":1593328620764,"updateTime":1593328620764,"version":0,"relationshipAttributes":{"schema":[],"inputToProcesses":[],"meanings":[],"table":{"guid":"52361402-2485-4760-9da8-6b73721e2322","typeName":"hive_table","entityStatus":"ACTIVE","displayText":"test","relationshipType":"hive_table_columns","relationshipGuid":"88c00151-9092-4b3e-a7cb-f4d3054b7895","relationshipStatus":"ACTIVE","relationshipAttributes":{"typeName":"hive_table_columns"}},"outputFromProcesses":[]}},"99d26453-01ef-4913-8b2a-59868ddae24e":{"typeName":"hive_storagedesc","attributes":{"replicatedTo":null,"replicatedFrom":null,"qualifiedName":"goudan.test@atlas-cluster_storage","inputFormat":"org.apache.hadoop.mapred.TextInputFormat","bucketCols":null,"sortCols":null,"storedAsSubDirectories":false,"location":"hdfs://mycluster/user/hive/warehouse/goudan.db/test","compressed":false,"outputFormat":"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat","parameters":null,"serdeInfo":{"typeName":"hive_serde","attributes":{"serializationLib":"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe","name":null,"parameters":{"serialization.format":"1"}}},"table":{"guid":"52361402-2485-4760-9da8-6b73721e2322","typeName":"hive_table"},"numBuckets":-1},"guid":"99d26453-01ef-4913-8b2a-59868ddae24e","status":"ACTIVE","createdBy":"root","updatedBy":"root","createTime":1593328620764,"updateTime":1593328620764,"version":0,"relationshipAttributes":{"meanings":[],"table":{"guid":"52361402-2485-4760-9da8-6b73721e2322","typeName":"hive_table","entityStatus":"ACTIVE","displayText":"test","relationshipType":"hive_table_storagedesc","relationshipGuid":"3aab2ee2-3c8d-4538-9baa-74172488f02d","relationshipStatus":"ACTIVE","relationshipAttributes":{"typeName":"hive_table_storagedesc"}}}}},"entity":{"typeName":"hive_table","attributes":{"owner":"root","temporary":false,"lastAccessTime":1593328620000,"aliases":null,"replicatedTo":null,"replicatedFrom":null,"qualifiedName":"goudan.test@atlas-cluster","columns":[{"guid":"0f022caa-b9e9-40f5-b2c2-8df4f8e25ebd","typeName":"hive_column"}],"description":null,"viewExpandedText":null,"tableType":"MANAGED_TABLE","sd":{"guid":"99d26453-01ef-4913-8b2a-59868ddae24e","typeName":"hive_storagedesc"},"createTime":1593328620000,"name":"test","comment":null,"partitionKeys":[],"parameters":{"totalSize":"0","numRows":"0","rawDataSize":"0","COLUMN_STATS_ACCURATE":"{\"BASIC_STATS\":\"true\"}","numFiles":"0","transient_lastDdlTime":"1593328620"},"retention":0,"viewOriginalText":null,"db":{"guid":"207571b3-3b6c-46c9-b7aa-26884acbe01b","typeName":"hive_db"}},"guid":"52361402-2485-4760-9da8-6b73721e2322","status":"ACTIVE","createdBy":"root","updatedBy":"root","createTime":1593328620764,"updateTime":1593328620764,"version":0,"relationshipAttributes":{"schema":[],"inputToProcesses":[],"sd":{"guid":"99d26453-01ef-4913-8b2a-59868ddae24e","typeName":"hive_storagedesc","entityStatus":"ACTIVE","displayText":"goudan.test@atlas-cluster_storage","relationshipType":"hive_table_storagedesc","relationshipGuid":"3aab2ee2-3c8d-4538-9baa-74172488f02d","relationshipStatus":"ACTIVE","relationshipAttributes":{"typeName":"hive_table_storagedesc"}},"columns":[{"guid":"0f022caa-b9e9-40f5-b2c2-8df4f8e25ebd","typeName":"hive_column","entityStatus":"ACTIVE","displayText":"id","relationshipType":"hive_table_columns","relationshipGuid":"88c00151-9092-4b3e-a7cb-f4d3054b7895","relationshipStatus":"ACTIVE","relationshipAttributes":{"typeName":"hive_table_columns"}}],"partitionKeys":[],"meanings":[],"db":{"guid":"207571b3-3b6c-46c9-b7aa-26884acbe01b","typeName":"hive_db","entityStatus":"ACTIVE","displayText":"goudan","relationshipType":"hive_table_db","relationshipGuid":"039b5a62-5182-436b-a311-8d3292251999","relationshipStatus":"ACTIVE","relationshipAttributes":{"typeName":"hive_table_db"}},"outputFromProcesses":[]}}}
3.GlossaryREST
4.LineageREST
4.1GET /v2/lineage/{guid}
Request Parameters
name | type | description | default | constraints |
---|---|---|---|---|
guid | path | - unique entity id | ||
depth | query | - number of hops for lineage | 3 | int |
direction | query | - input, output or both | BOTH | “BOTH” or “INPUT” or “OUTPUT” |
5.RelationshipREST
6.TypesREST
6.1DELETE /v2/types/typedefs
Example
6.2GET /v2/types/typedefs
Example
[root@testkafka-01 bin]# curl -u admin:admin -X GET 'http://testkafka-01:21000/api/atlas/v2/types/typedefs'
返回的太多了,就不贴了