全部产品
Search
文档中心

智能开放搜索 OpenSearch:CreateAppGroupCredentials - 创建应用组凭据

更新时间:Oct 16, 2024

按需创建指定应用组的访问凭据,支持dryRun模式预览操作。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:WriteAppGroupCredentialcreate
  • AppGroupCredential
    acs:opensearch:{#regionId}:{#accountId}:appGroup/{#AppGroupId}

请求语法

POST /v4/openapi/app-groups/{appGroupIdentity}/credentials HTTP/1.1

请求参数

名称类型必填描述示例值
dryRunboolean

指定此次操作是否为 dry run,即只检查参数,不实际执行操作。

bodyobject

请求体,包含凭据类型等信息。

typestring

凭据类型,如 api-key、account、invoke-key 或 api-token。创建 api-key 时写为 api-token。

api-token
appGroupIdentitystring

应用组标识符。

app_group_123

返回参数

名称类型描述示例值
object

成功响应的结构。

requestIdstring

请求唯一标识。

1-2-3-4
resultobject

操作结果详情。

appGroupIdlong

应用组 ID。

app_group_123
typestring

凭据类型。

api-token
enabledboolean

凭据是否启用。

tokenstring

生成的凭据令牌。

generated_token_string

示例

正常返回示例

JSON格式

{
  "requestId": "1-2-3-4",
  "result": {
    "appGroupId": 0,
    "type": "api-token",
    "enabled": true,
    "token": "generated_token_string"
  }
}

错误码

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