简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
Restful API
Elasticsearch官方参考文档 单文档API：Index API Get API Delete API Update API 多文档API：Multi Get API Bulk API Delete By Query API Update By Query API Reindex API 使用REST Client交互 客户端访问仅支持HTTP/TCP方式，建议您...
DescribeApisByBackend-根据后端查询 API 列表
GET ApiName string API 名称 testApi 示例 正常返回示例 JSON 格式 {"PageNumber":1,"RequestId":"CEB6EC62-B6C7-5082-A45A-45A204724AC2","PageSize":10,"TotalCount":1,"ApiInfoList":{"ApiInfo":[{"ApiId":"20bcdc9453524b78a8beb1f6de...
ImportSwagger-通过 Swagger 创建 API
接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
DryRunSwagger-预检查swagger
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
时序数据对接Grafana
支持的API如下：API名称 示例 Instant queries GET/api/v1/query POST/api/v1/query Range queries GET/api/v1/query_range POST/api/v1/query_range Getting label names GET/api/v1/labels POST/api/v1/labels Querying label values GET...
GetResources-查询资源
api/v1/providers/Aliyun/products/ECS/resources/Instance/i-123*RDS Instance List:/api/v1/providers/Aliyun/products/RDS/resources/DBInstance RDS Instance Get:/api/v1/providers/Aliyun/products/RDS/resources/DBInstance/r-123*...
ListProducts-列举产品
接口说明 GET/api/v1/providers/{provider}/products。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 ...
GetTask-查询任务
接口说明 GET/api/v1/tasks/{taskId}。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
GetUser-获取基本信息
请求语法 GET/api/v2/users 请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 返回参数 名称 类型 描述 示例值 object 成功获取基本信息。Data object 返回数据。AccountStatus integer 账号状态。0:正常使用。1:因欠费等原因暂时...
GetLock-查询元数据锁
请求语法 GET/api/metastore/catalogs/databases/tables/locks 请求参数 名称 类型 必填 描述 示例值 LockId long 否 LockId 16533 lockid，即从 createlock 返回的 lockid 返回参数 名称 类型 描述 示例值 object Lock response Code ...
GetToken-获取任务分享令牌
请求语法 GET/api/v1/tokens 请求参数 名称 类型 必填 描述 示例值 TargetType string 否 分享的任务类型，只可指定 job 或者 tensorboard job TargetId string 否 等待分享的任务的 ID dlc*ExpireTime long 否 分享链接过期时间（默认为 ...
ListDataSources-查询资源属性可选值
请求语法 GET/api/v1/providers/{provider}/products/{product}/dataSources/*请求参数 名称 类型 必填 描述 示例值 requestPath string 是 请求路径。格式为：/api/v1/providers/{provider}/products/{product}/dataSources/{resourceType...
GetLayer-获取层详细信息
请求语法 GET/api/v1/layers/{LayerId} 请求参数 名称 类型 必填 描述 示例值 LayerId string 是 层 ID，可通过接口 ListLayers 获取。3 InstanceId string 是 实例 ID，可通过接口 ListInstances 获取。pairec-cn-abcdefg1234 返回参数 ...
小程序权限
说明 小程序配置是以应用和用户两个维度存储的，因此要确保应用已经调用 MPLogger.setUserId 方法。API 未被调用时，该 API 对应的 key 值授权状态是获取不到的。写入配置请调用如下方法：RVProxy.get(ApiPermissionConfigManagerProxy....
GetMessageConfig-获取短信配置
请求语法 GET/api/v2/users/messageConfig 请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 返回参数 名称 类型 描述 示例值 object 成功获取短信配置。Data object 返回数据。SmsReportUrl string 短信发送状态回执接收服务地址...
GetAsyncTaskStatus-获取异步任务状态
请求语法 GET/api/metastore/catalogs/tasks 请求参数 名称 类型 必填 描述 示例值 CatalogId string 否 数据库分类命名空间，默认填写主账号 Uid 1344371 TaskId string 否 异步任务返回的结果中获取 f546c761570e5efc8146a1986f7890d2 ...
GetScene-获取场景详细信息
请求语法 GET/api/v1/scenes/{SceneId} 请求参数 名称 类型 必填 描述 示例值 SceneId string 否 场景 ID，可通过接口 ListScenes 获取。3 InstanceId string 否 实例 ID，可通过接口 ListInstances 获取。pairec-cn-abcdefg1234 返回参数 ...
GetToken-获取实例临时鉴权信息
请求语法 GET/api/v2/tokens 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 ID。dsw-730xxxxxxxxxx ExpireTime integer 否 过期时间，单位为秒。60 返回参数 名称 类型 描述 示例值 object 返回结构体。RequestId string...
支持的开源API
mapping/field/{fields} GET/_mappings GET/_mappings/{type} PUT、POST/_open POST/_refresh GET、POST/_resolve/index/{name} GET/_settings PUT、GET/_settings/{name} GET/_stats GET/_stats/{metric} GET/_template GET/_template/{...
GetCatalog-获取目录详情
请求语法 GET/api/metastore/catalogs 请求参数 名称 类型 必填 描述 示例值 CatalogId string 否 catalogId catalog_test 返回参数 名称 类型 描述 示例值 object Databases Response Code string Code OK Message string Message....
GetSubCrowd-获取子人群详细信息
请求语法 GET/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId} 请求参数 名称 类型 必填 描述 示例值 CrowdId string 是 人群 ID，可通过接口 ListCrowds 获取。3 SubCrowdId string 是 子人群 ID，可通过接口 ListSubCrowds 获取。4 ...
GetAlgorithm-获取算法详情
请求语法 GET/api/v2/algorithms/{Id} 请求参数 名称 类型 必填 描述 示例值 Id string 否 算法 ID，可通过 ListAlgorithms 查询当前可用算法，使用获取的算法 ID。0bddaf8f-5628-427a-8652-5e24f6b4c35d 返回参数 名称 类型 描述 示例值 ...
GetInstanceResourceTable-获取资源下表信息
请求语法 GET/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables/{TableName} 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 ID，可通过接口 ListInstances 获取。pairec-cn-test1 ResourceId string 是 ...
GetABMetricGroup-获取指标组详细信息
请求语法 GET/api/v1/abmetricgroups/{ABMetricGroupId} 请求参数 名称 类型 必填 描述 示例值 ABMetricGroupId string 是 指标组 ID。1 InstanceId string 是 实例 ID，可通过接口 ListInstances 获取。pairec-cn-test1 返回参数 名称 ...
ListResourceTypes-列举资源类型
接口说明 GET/api/v1/providers/{provider}/products/{product}/resourceTypes。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无...
GetCalculationJob-获取计算任务
请求语法 GET/api/v1/calculationjobs/{CalculationJobId} 请求参数 名称 类型 必填 描述 示例值 CalculationJobId string 是 计算任务 ID。1 InstanceId string 是 实例 ID，可通过接口 ListInstances 获取。pairec-cn-test1 返回参数 ...
GetPermission-获取工作空间的权限
请求语法 GET/api/v1/workspaces/{WorkspaceId}/permissions/{PermissionCode} 请求参数 名称 类型 必填 描述 示例值 WorkspaceId string 是 工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces。123 PermissionCode string 是 权限...
GetPrice-资源询价
操作 访问级别 资源类型 条件关键字 关联操作 cloudcontrol:GetPrice Write 全部资源*无 无 请求语法 GET/api/v1/providers/{provider}/products/{product}/price/*请求参数 名称 类型 必填 描述 示例值 requestPath string 否 请求路径。...
GetTrustedProjects-获取受信任项目列表
操作 访问级别 资源类型 条件关键字 关联操作 odps:GetTrustedProjects 全部资源*无 无 请求语法 GET/api/v1/projects/{projectName}/trustedProjects 请求参数 名称 类型 必填 描述 示例值 projectName string 是 项目名称。odps_project ...
GetJobEvents-获取任务的系统事件
请求语法 GET/api/v1/jobs/{JobId}/events 请求参数 名称 类型 必填 描述 示例值 JobId string 是 任务 ID。如何获取任务 ID，请参见 ListJobs。dlc-20210126170216-*MaxEventsNum integer 否 获取事件的最大数目，默认值：2000。100 ...
GetPackage-获取Package信息
请求语法 GET/api/v1/projects/{projectName}/packages/{packageName} 请求参数 名称 类型 必填 描述 示例值 projectName string 是 MaxCompute 项目名称 projectA packageName string 是 package 名称 test_package sourceProject string ...
GetInstanceResource-获取资源详细信息
请求语法 GET/api/v1/instances/{InstanceId}/resources/{ResourceId} 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 ID，可通过接口 ListInstances 获取。pairec-cn-test1 ResourceId string 是 资源 ID。reso-2s416t*...
GetUserConfig-查询用户信息
请求语法 GET/api/v2/userconfig 请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 返回参数 名称 类型 描述 示例值 object 用户配置。AccountSufficient boolean 用户账号金额是否充足。false FreeTierSpecAvailable boolean ...
GetSignature-获取签名详情
请求语法 GET/api/v2/signatures/{Id} 请求参数 名称 类型 必填 描述 示例值 Id string 否 签名 Id，可通过 ListSignatures 查询账号下的签名列表，获取签名 Id。0a54e195-03e2-40bd-869d-b71cb302783e 返回参数 名称 类型 描述 示例值 ...
GetOrgAndFactory-获取组织和场站
请求语法 GET/api/external/getOrgAndFactory 请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 无请求参数，直接查询账号下激活的场站信息。返回参数 名称 类型 描述 示例值 object Schema of Response requestId string 请求 ID...
GetMember-获取工作空间的成员
请求语法 GET/api/v1/workspaces/{WorkspaceId}/member 请求参数 名称 类型 必填 描述 示例值 WorkspaceId string 是 工作空间ID。如何获取工作空间ID，请参见 ListWorkspaces。145883 UserId string 否 用户UID。如何查看用户UID，请参见 ...
GetInstanceMetrics-获取实例指标
请求语法 GET/api/v2/instance/{InstanceId}/metrics 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 ID。如何获取实例 ID，请参见 ListInstances。dsw-730xxxxxxxxxx MetricType string 是 实例指标类型，取值如下：...
GetResourceType-查询资源类型的详情
请求语法 GET/api/v1/providers/{provider}/products/{product}/resourceTypes/*请求参数 名称 类型 必填 描述 示例值 x-acs-accept-language string 否 选择返回产品的语言。zh_CH：中文（默认）en_US：英文。zh_CH requestPath string 是...
- 产品推荐
- 这些文档可能帮助您