全部产品
Search

搜索本产品

    资源编排：GetServiceProvisions - 查询服务开通状态

    文档中心

    资源编排：GetServiceProvisions - 查询服务开通状态

    更新时间：Sep 23, 2024

    查询服务开通状态和服务角色信息。

    接口说明

    使用说明

    本文将提供一个示例，在杭州地域查询弹性高性能计算的开通状态及服务角色信息。

    说明 请确保您已具备调用 GetRole 接口的权限。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    ros:GetServiceProvisionslist
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    地域 ID。 您可以调用 DescribeRegions 查看最新的阿里云地域列表。

    		cn-hangzhou
    TemplateBodystring否

    模板主体的结构。长度为 1~524,288 个字节。如果长度较长，则建议通过 HTTP POST+Body Param 的方式，将参数放在请求体中进行传递，避免因 URL 过长而导致请求失败。

    说明 您必须且仅能指定 TemplateBody、TemplateURL、TemplateId 或 TemplateScratchId 其中一个参数。
    		ROSTemplateFormatVersion: '2015-09-01'\r\nResources:\r\n Vpc:\r\n Type: ALIYUN::ECS::VPC\r\n Properties:\r\n CidrBlock: 192.168.0.0/24\r\n VpcName: TestVpc
    TemplateURLstring否

    包含模板主体的文件的位置。URL 必须指向位于 HTTP Web 服务器（HTTP 或 HTTPS）或阿里云 OSS 存储空间中的模板（1~524,288 个字节）。OSS 存储空间的 URL，例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地域，默认与接口参数 RegionId 相同。

    您必须且仅能指定 TemplateBody、TemplateURL、TemplateId 或 Services 其中一个参数。

    		oss://ros-template/demo
    TemplateIdstring否

    模板 ID。支持共享模板和私有模板。

    您必须且仅能指定 TemplateBody、TemplateURL、TemplateId 或 Services 其中一个参数。

    		5ecd1e10-b0e9-4389-a565-e4c15efc****
    TemplateVersionstring否

    模板版本。如果不指定，默认取最新版本。

    TemplateVersion 仅在指定 TemplateId 时生效。

    		v1
    Parametersarray<object>否

    参数。

    object否
    ParameterKeystring是

    参数的名称。如果未指定参数的名称和值，则 ROS 将使用模板中指定的默认值。

    说明 Parameters 为可选参数。若指定了 Parameters，则 ParameterKey 为必选参数。
    		Amount
    ParameterValuestring是

    参数的值。

    说明 Parameters 为可选参数。若指定了 Parameters，则 ParameterValue 为必选参数。
    		12
    Servicesarray<object>否

    云服务列表。

    object否
    ServiceNamestring是

    云服务名称。取值：

    • AHAS：应用高可用服务。

    • ARMS：应用实时监控服务。

    • ApiGateway：API 网关。

    • BatchCompute：批量计算。

    • BrainIndustrial：工业大脑。

    • CloudStorageGateway：云存储网关。

    • CMS：云监控。

    • CR：镜像容器服务。

    • CS：容器服务。

    • DCDN：全站加速。

    • DataHub：数据总线。

    • DataWorks：数据工场。

    • EDAS：企业级分布式应用服务。

    • EHPC：弹性高性能计算。

    • EMAS：移动研发平台。

    • FC：函数计算。

    • FNF：Serverless 工作流。

    • MaxCompute：大数据计算服务。

    • SMQ：轻量消息队列（原 MNS）。

    • HBR：云备份。

    • IMM：智能媒体管理。

    • IOT：物联网平台。

    • KMS：密钥管理服务。

    • NAS：文件存储。

    • NLP：自然语言处理。

    • OSS：对象存储服务。

    • OTS：表格存储。

    • PrivateLink：私网连接。

    • PrivateZone：云解析。

    • RocketMQ：消息队列 RocketMQ 版。

    • SAE：应用引擎。

    • SLS：日志服务。

    • TrafficMirror：流量镜像。

    • VS：视频监控。

    • Xtrace：链路追踪。

    		EHPC

    关于公共请求参数的详情，请参见公共参数。

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		A9938C04-26AD-5EFA-B394-EA7866842DFF
    ServiceProvisionsarray<object>

    云服务详情。

    object
    ServiceNamestring

    云服务名称。

    		EHPC
    Statusstring

    云服务开通状态。取值：

    • Enabled：已开通。

    • Disabled：未开通。

    • Unknown：开通状态未知。

    		Enabled
    StatusReasonstring

    云服务未开通或开通状态未知的原因。

    说明 当 Status 取值为 Disabled 或 Unknown 时，返回该参数。
    		No permission.
    AutoEnableServiceboolean

    是否在模板中定义了自动开通服务。取值：

    • true：自动开通。

    • false：手动开通。

    		false
    EnableURLstring

    云服务开通链接。

    说明 当 Status 取值为 Disabled 时，返回该参数。
    		https://common-buy.aliyun.com/?commodityCode=nas
    RoleProvisionobject

    云服务角色信息。若为空表示没有服务角色。

    AuthorizationURLstring

    角色授权链接。

    说明 当 Created 取值为 false 时，返回该参数。
    		https://ehpc.console.aliyun.com/
    Rolesarray<object>

    云服务角色列表。

    object
    RoleNamestring

    角色名称。

    		AliyunServiceRoleForEHPC
    Createdboolean

    角色是否已创建。取值：

    • true：已创建。

    • false：未创建。

    		true
    Functionstring

    角色用途。 默认值：Default，表示该角色为服务默认角色。

    		Default
    ApiForCreationobject

    创建角色用到的 API 信息。

    ApiProductIdstring

    API 所属产品 ID。

    		rds
    ApiNamestring

    API 名称。

    		CreateServiceLinkedRole
    ApiTypestring

    API 类型。 取值：

    • Open：开放 API。

    • Inner：内部 API。

    		Open
    Parametersobject

    API 参数信息。${变量名}表示动态参数，目前支持：${RegionId} 地域。

    		{ "ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs", "RegionId": "${RegionId}" }
    DependentServiceNamesarray

    待查询服务依赖的服务列表。

    string

    待查询服务依赖的服务名称。

    		NAS

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "A9938C04-26AD-5EFA-B394-EA7866842DFF",
  "ServiceProvisions": [
    {
      "ServiceName": "EHPC",
      "Status": "Enabled",
      "StatusReason": "No permission.",
      "AutoEnableService": false,
      "EnableURL": "https://common-buy.aliyun.com/?commodityCode=nas",
      "RoleProvision": {
        "AuthorizationURL": "https://ehpc.console.aliyun.com/",
        "Roles": [
          {
            "RoleName": "AliyunServiceRoleForEHPC",
            "Created": true,
            "Function": "Default",
            "ApiForCreation": {
              "ApiProductId": "rds",
              "ApiName": "CreateServiceLinkedRole",
              "ApiType": "Open",
              "Parameters": {
                "ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs",
                "RegionId": "${RegionId}"
              }
            }
          }
        ]
      },
      "DependentServiceNames": [
        "NAS"
      ]
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-01-12API 内部配置变更，不影响调用查看变更详情
    2022-10-28OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情
    2021-11-12OpenAPI 返回结构发生变更查看变更详情