实例概要API 2.0

实例概要API允许管理员添加、列出和删除用户可以用来启动集群的实例概要。普通用户可以列出对他们可用的实例概要。看到使用实例概要配置S3访问获取更多信息。

重要的

要访问Databricks REST api，必须进行身份验证。

添加

端点	HTTP方法
`2.0 / instance-profiles /添加`	`帖子`

注册一个实例概要文件。在UI中，您可以在启动集群时选择实例概要文件。

此API仅对管理用户可用。

例子

              —netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/instance-profiles/add＼——数据'{"instance_profile_arn": "arn:aws:iam::123456789012:instance-profile/my-profile"}'
             

{}

请求结构

字段名	类型	描述
instance_profile_arn	`字符串`	要向Databricks注册的实例概要文件的AWS ARN。它应该是这样的:`攻击:aws:我::<帐户id >: instance-profile / <名称>`。该字段为必填项。
iam_role_arn	`字符串`	AWS IAM角色实例概要文件关联角色的ARN。它必须有形式`攻击:aws:我::<帐户id >:角色/ <名称>`。如果您的角色名和实例概要名称不匹配，并且您希望使用实例概要，则此字段是必需的Databricks SQL Serverless。否则，该字段是可选的。
is_meta_instance_profile	`保龄球`	实例概要文件是否是元实例概要文件。仅用于IAM证书传递。该字段可选。
skip_validation	`保龄球`	默认情况下，Databricks验证它是否有足够的权限使用实例概要启动实例。此验证使用AWS干运行模式`RunInstances`API。如果验证失败并提示错误消息，该错误消息并不表明与IAM相关的权限问题，(例如“您请求的可用分区不支持您请求的实例类型”)，您可以传递此标志来跳过验证并强制添加实例配置文件。

编辑

端点	HTTP方法
`2.0 / instance-profiles /编辑`	`帖子`

编辑一个实例概要文件，但唯一支持更改的字段是与实例概要文件关联的可选IAM角色ARN。当以下两种情况都为时，需要指定IAM角色ARN:

您的角色名称和实例概要名称不匹配。名称是每个ARN中最后一个斜杠后面的部分。
的实例概要文件Databricks SQL Serverless。

要了解这些字段在AWS控制台中的位置，请参见启用无服务器SQL仓库。

此API仅对管理用户可用。

例子

              —netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/instance-profiles/edit＼——数据'{"instance_profile_arn": "arn:aws:iam::123456789012:instance-profile/my-profile"，"iam_role_arn": "arn:aws:iam::123456789012:role/my-profile2"}'
             

{}

请求结构

字段名	类型	描述
instance_profile_arn	`字符串`	要注册到的实例概要文件的AWS ARN 。它应该是这样的:`攻击:aws:我::<帐户id >: instance-profile / <名称>`。该字段为必填项。该字段标识要修改的已注册实例概要文件。
iam_role_arn	`字符串`	AWS IAM角色实例概要文件关联角色的ARN。它必须有形式`攻击:aws:我::<帐户id >:角色/ <名称>`。该字段为必填项。

列表

端点	HTTP方法
`2.0 / instance-profiles /列表`	`得到`

列出主叫用户可用于启动集群的实例概要。

所有用户都可以使用这个API。

例子

              —netrc -X GET＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/instance-profiles/list＼|金桥。
             

              ｛“instance_profiles”：(｛“instance_profile_arn”：“攻击:aws:我::123456789012:instance-profile /我的资料”，“is_meta_instance_profile”：假｝］｝
             

响应结构

字段名	类型	描述
instance_profiles	的数组InstanceProfile	用户可以访问的实例概要文件列表。

删除

端点	HTTP方法
`2.0 / instance-profiles /删除`	`帖子`

使用提供的ARN删除实例概要文件。具有此实例概要的现有集群将继续工作。

此API仅供管理员用户访问。

例子

              —netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/instance-profiles/remove＼——数据'{"instance_profile_arn": "arn:aws:iam::123456789012:instance-profile/my-profile"}'
             

{}

请求结构

字段名	类型	描述
instance_profile_arn	`字符串`	要删除的实例概要文件的ARN。该字段为必填项。

数据结构

本节:

InstanceProfile

InstanceProfile

在启动集群时可以附加到实例的IAM实例配置文件。

字段名	类型	描述
instance_profile_arn	`字符串`	要向Databricks注册的实例概要文件的AWS ARN。它应该是这样的:`攻击:aws:我::<帐户id >: instance-profile / <名称>`。该字段为必填项。
is_meta_instance_profile	`保龄球`	实例概要文件是否是元实例概要文件。仅用于IAM证书传递。有关更多信息，请参见设置一个元实例概要文件。