云编排 API
提供者
Cloud Orchestration API NetApp 服务引擎支持将 Cloud Volumes 服务连接到 NetApp 服务引擎,并可在 NetApp 服务引擎中使用这些服务。Cloud Volumes 服务支持 Azure NetApp Files ( ANF )和 Google Cloud Platform ( GCP )。
Cloud Volumes Services 的订阅在 NetApp 服务引擎之外进行管理。NetApp 服务引擎可通过相关凭据连接到云服务。
本节介绍以下 API :
-
管理 Cloud Volumes Service 实例
-
管理 Azure NetApp Files 帐户
-
管理 Azure NetApp Files 容量池
-
管理 Azure NetApp Files 卷
-
管理 Google Cloud Volumes
Cloud Volumes Service 实例
使用下表中列出的方法检索和创建 Cloud Volumes Service 实例。
HTTP 方法 | 路径 | Description |
---|---|---|
|
` v2.1/vcs/instances` |
检索所有 Cloud Volumes Service 实例。 |
|
` v2.1/vcs/instances` |
创建新的 Cloud Volumes Service 实例。 |
|
` v2.1/vcs/instances/{ id }` |
按 ID 检索 Cloud Volumes Service 实例。 |
|
` /v2.1/anf/ 帐户` |
检索 Azure NetApp Files 帐户。 |
|
` /v2.1/anf/ 帐户` |
创建 Azure NetApp Files 帐户 |
|
` /v2.1/anf/accouns/ { id }` |
按 ID 检索 Azure NetApp Files 帐户。 |
|
` v2.1/anf/Pools` |
检索所有容量池。 |
|
` v2.1/anf/Pools`` |
创建容量池。 |
|
` /v2.1/anf/pools/ { id }` |
按 ID 检索 Azure NetApp Files 容量池。 |
Cloud Volumes Service 实例属性
下表列出了 Cloud Volumes Service 实例属性。
属性 | Type | Description |
---|---|---|
|
string |
Cloud Volumes Service 实例的唯一标识符。 |
|
string |
Cloud Volumes Service 实例的名称。 |
|
string |
BlueXP中的工作环境名称。 |
|
string |
Auth0 服务 ID 。 |
|
string |
Auth0 刷新令牌。 |
|
string |
Cloud Central 帐户 ID 。 |
|
string |
Cloud Central 帐户名称。 |
|
string |
以云为中心的工作环境的 ID 。 |
|
string |
应用程序(客户端) ID 。BlueXP可用于向Azure Active Directory进行身份验证的Active Directory服务主体的ID。 |
|
string |
服务主体应用程序的客户端密钥值。 |
|
string |
Azure Active Directory ID 。这也称为租户 ID 。 |
|
string |
Azure Active Directory 订阅 ID 。 |
|
string |
子租户 ID 。 |
|
键值对。 |
检索 Cloud Volumes Service 实例
HTTP 方法 | 路径 | Description | 路径参数 |
---|---|---|---|
|
` v2.1/vcs/instances` |
检索 Cloud Volumes Service 实例。 |
|
所需的请求正文参数: none
按 ID 检索 Cloud Volumes Service 实例
使用下表中列出的方法按标识符检索 Cloud Volumes Service 实例。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` v2.1/vcs/instances/{ id }` |
按 ID 检索 Cloud Volumes Service 实例。 |
|
所需的请求正文属性: none
创建 Cloud Volumes Service 实例
使用下表中列出的方法创建新的 Cloud Volumes Service 实例。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` v2.1/vcs/instances` |
创建 Cloud Volumes Service 实例。 |
无 |
所需的请求正文属性: name , cc_working _env , cc_client_id , cc_refresh_token , cc_account_id , cc_account_name , azure_client_id , azure_client_secret , azure_tenant_id , azure_subscription_id , subtenant_id
-
请求正文示例: *
{ "name": "instance1", "cc_working_env": "my-working-env", "cc_client_id": "Mu0V1ywgYteI6w1MbD15fKfVIUrNXGWC", "cc_refresh_token": "y1tMw3lNzE8JL9jtiE29oSRxOAzYu0cdnwS_2XhjQBr9G", "cc_account_id": "account-335jdf32", "cc_account_name": "my-account-name", "cc_credentials_id": "d336c449-aeb8-4bb3-af28-5b886c40dd00", "azure_client_id": "53ba6f2b-6d52-4f5c-8ae0-7adc20808854", "azure_client_secret": "NMubGVcDqkwwGnCs6fa01tqlkTisfUd4pBBYgcxxx=", "azure_tenant_id": "53ba6f2b-6d52-4f5c-8ae0-7adc20808854", "azure_subscription_id": "1933a261-d141-4c68-9d6c-13b607790910", "subtenant_id": "5d2fb0fb4f47df00015274e3", "tags": { "key1": "Value 1", "key2": "Value 2", "key3": "Value 3", "keyN": "Value N" } }
管理 Cloud Volumes Service 实例的标记
使用下表中列出的方法为命名的 Cloud Volumes Service 实例指定标记。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` v2.1/vcs/instances/{ id } /tags` |
管理 Cloud Volumes Service 实例的标记。 |
|
所需的请求正文属性: key-value pairs
-
请求正文示例: *
{ "env": "test" }
Azure NetApp Files 帐户
Azure NetApp Files 帐户属性
下表列出了 Azure NetApp Files 帐户属性。
属性 | Type | Description |
---|---|---|
|
string |
Azure NetApp Files 帐户的唯一标识符。 |
|
string |
Azure NetApp Files 帐户的名称。 |
|
string |
Azure 资源组。 |
|
string |
Azure 位置(区域 / 区域)。 |
|
string |
Cloud Volumes Service 实例标识符。 |
|
– |
键值对。 |
检索 Azure NetApp Files 帐户
HTTP 方法 | 路径 | Description | 路径参数 |
---|---|---|---|
|
` /v2.1/anf/ 帐户` |
检索 Azure NetApp Files 帐户。 |
|
所需的请求正文参数: none
按名称检索 Azure NetApp Files 帐户
使用下表中列出的方法按名称检索 Azure NetApp Files 帐户。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` /v2.1/anf/accouns/ { name }` |
按名称检索 Azure NetApp Files 帐户。 |
|
所需的请求正文属性: none
创建 Azure NetApp Files 帐户
使用下表中列出的方法创建新的 Azure NetApp Files 帐户。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` /v2.1/anf/ 帐户` |
创建新的 Azure NetApp Files 帐户。 |
无 |
所需的请求正文属性: name , resource_group , location , cvs_instation_id
-
请求正文示例: *
{ "name": "string", "resource_group": "string", "location": "string", "cvs_instance_id": "5d2fb0fb4f47df00015274e3", "tags": { "key1": "Value 1", "key2": "Value 2", "key3": "Value 3", "keyN": "Value N" } }
Azure NetApp Files 容量池
容量池属性
下表列出了容量池属性。
属性 | Type | Description |
---|---|---|
|
string |
容量池的唯一标识符。 |
|
string |
容量池的名称。 |
|
string |
Azure 资源组。 |
|
string |
Azure 位置(区域 / 区域)。 |
|
整型 |
容量池的大小(以 TB 为单位)。 |
|
string |
适用的服务级别名称: " 超 " , " 高级 " 或 " 标准 " 。 |
|
string |
Azure NetApp Files 帐户实例标识符。 |
|
string |
子租户 ID 。 |
|
– |
键值对。 |
检索容量池
HTTP 方法 | 路径 | Description | 路径参数 |
---|---|---|---|
|
` v2.1/anf/Pools` |
检索容量池。 |
|
所需的请求正文参数: none
-
请求正文示例: *
none
按名称检索容量池
使用下表中列出的方法按名称检索容量池。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` /v2.1/anf/pools/ { name }` |
按名称检索容量池。 |
|
所需的请求正文属性: none
创建容量池
使用下表中列出的方法创建新的容量池。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` v2.1/anf/Pools` |
创建容量池。 |
无 |
所需的请求正文属性: name , resource_group , location , size , service_level , anf_account_name , subtenant_id
-
请求正文示例: *
{ "name": "string", "resource_group": "string", "location": "string", "size": 10, "service_level": "Standard", "anf_account_name": "myaccount", "subtenant_id": "5d2fb0fb4f47df00015274e3", "tags": { "key1": "Value 1", "key2": "Value 2", "key3": "Value 3", "keyN": "Value N" } }
修改容量池的大小
使用下表中列出的方法修改容量池的大小。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` /v2.1/anf/pools/ { name }` |
修改容量池的大小。 |
|
所需的请求正文属性: name , resource_group , location , anf_account_name , size , service_level , subtenant_id
-
请求正文示例: *
{ "name": "myaccount", "resource_group": "string", "location": "string", "anf_account_name": "myaccount", "size": 4, "service_level": "Standard", "subtenant_id": "5d2fb0fb4f47df00015274e3", "tags": { "key1": "Value 1", "key2": "Value 2", "key3": "Value 3", "keyN": "Value N" } }
Azure NetApp Files 卷
Azure NetApp Files 卷属性
下表列出了 Azure NetApp Files 卷的属性。
属性 | Type | Description |
---|---|---|
|
string |
Azure NetApp Files 卷的唯一标识符。 |
|
string |
Azure NetApp Files 卷的名称。 |
|
string |
Azure 资源组。 |
|
string |
子租户 ID 。 |
|
string |
Azure NetApp Files 帐户名称。 |
|
string |
Azure NetApp Files 池名称。 |
|
string |
Azure 位置(区域 / 区域)。 |
|
string |
创建令牌或文件路径。用于访问卷的唯一文件路径。 |
|
整型 |
GiB 允许的最大存储配额。 |
|
string |
委派子网的 Azure 资源 URL 。必须具有委派 Microsoft NetApp/volumes 。 |
|
– |
键值对。 |
检索 Azure NetApp Files 卷
使用下表中列出的方法检索 Azure NetApp Files 卷。指定 tenant_id
仅返回属于该租户的帐户。
HTTP 方法 | 路径 | Description | 路径参数 |
---|---|---|---|
|
` v2.1/anf/volumes` |
检索 Azure NetApp Files 卷。 |
|
所需的请求正文参数: none
。
按名称检索 Azure NetApp Files 卷
使用下表中列出的方法按名称检索 Azure NetApp Files 卷。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` /v2.1/anf/volumes/{ name }` |
按名称检索 Azure NetApp Files 卷。 |
|
所需的请求正文属性: none
-
请求正文示例: *
none
创建 Azure NetApp Files 卷
使用下表中列出的方法创建新的 Azure NetApp Files 卷。
HTTP 方法 | 路径 | Description | Parameters |
---|---|---|---|
|
` v2.1/anf/volumes` |
创建 Azure NetApp Files 卷 |
无 |
所需的请求正文属性: name , resource_group , subtenant_id , anf_account_name , anf_pool_name , virtual_network , location , file_path , quota_size , subNetID
-
请求正文示例: *
{ "name": "myVolume", "resource_group": "string", "subtenant_id": "5d2fb0fb4f47df00015274e3", "anf_account_name": "myaccount", "anf_pool_name": "myaccount", "virtual_network": "anf-vnet", "location": "string", "file_path": "myVolume", "quota_size": 100, "subNetId": "string", "protocol_types": [ "string" ], "tags": { "key1": "Value 1", "key2": "Value 2", "key3": "Value 3", "keyN": "Value N" } }
管理适用于 Google Cloud 的 Cloud Volumes Service
您可以使用云编排类别下的 ` /v2.1/gcp/volumes` API 来管理 Google Cloud 实例的云卷。运行此 API 之前,请确保已为子租户启用 Google 云平台( GCP )订阅的 Cloud Volumes Service 帐户。
HTTP 动词 | 路径 | Description | 必需参数 / 请求正文 |
---|---|---|---|
|
` v2.1/gcp/ 卷` |
您可以使用 GET 方法检索为子租户的 Cloud Volumes Service 订阅创建的所有 Google 云卷的详细信息。 |
|
|
` /v2.1/gcp/volumes/{ id }` |
您可以使用此方法检索为子租户的 Cloud Volumes Service 订阅创建的特定 Google 云卷的详细信息。 |
|
|
` v2.1/gcp/ 卷` |
为子租户创建 GCP 卷。在请求正文中添加值以使用指定参数创建卷。 |
|
PUT |
` /v2.1/gcp/volumes/{ id }` |
修改已为子租户创建的 GCP 卷。在请求正文中添加要修改的卷的卷 ID 以及要修改的参数的值。 |
|
删除 |
` /v2.1/gcp/volumes/{ id }` |
您可以使用此方法删除为子租户的 Cloud Volumes Service 订阅创建的特定 Google 云卷。 |
|