All Products
Search

This Product

    Security Center:GenerateK8sAccessInfo

    Document Center

    Security Center:GenerateK8sAccessInfo

    Last Updated:Sep 07, 2026

    Generates an access command for a self-managed Kubernetes cluster.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-sas:GenerateK8sAccessInfo

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterName

    string

    Yes

    The name of the Kubernetes cluster.

    test
    GroupId

    integer

    Yes

    The ID of the server group.

    11341690
    Vendor

    string

    Yes

    The cloud asset vendor. Valid values:

    • Tencent

    • HUAWEICLOUD

    • Azure

    • AWS

    • Other cloud assets

    Tencent
    ExpireDate

    integer

    Yes

    The expiration time for container access. This value is a UNIX timestamp in milliseconds.

    1711951508388
    AuditRegionId

    string

    No

    The region of the audit log.

    cn-hangzhou
    AuditProject

    string

    No

    The Simple Log Service (SLS) project for audit logs.

    k8s-log-custom-huxintest1018-2
    AuditLogStore

    string

    No

    The SLS Logstore for audit logs.

    audit-cf6baf6afa106eca665296fdf68b65bf
    AliyunYundunGatewayProjectName

    string

    No

    [Deprecated] This parameter is deprecated and does not need to be specified.

    None
    AliyunYundunGatewayApiName

    string

    No

    [Deprecated] This parameter is deprecated and does not need to be specified.

    None
    AliyunYundunGatewayPopName

    string

    No

    [Deprecated] This parameter is deprecated and does not need to be specified.

    None
    CpuArch

    string

    No

    The CPU architecture, which can be ARM architecture or x86 architecture.

    arm

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique request ID generated by Alibaba Cloud for this request.

    061955B2-BC40-589F-AF63-C40A901EE279
    Data

    object

    The returned data.

    ClusterName

    string

    The cluster name.

    test
    AliUid

    integer

    The Alibaba Cloud UID of the user.

    1766185894104***
    InstallKey

    string

    The installation key for the server.

    BC66185***
    ClusterId

    string

    The cluster ID.

    c8ca91e0907d94efaba7fb0827eb9****
    GroupId

    string

    The server group ID.

    11618788
    ExpireDate

    integer

    The expiration time, in milliseconds.

    1804230578566
    AuditRegionId

    string

    The region ID of the server.

    cn-hangzhou
    AuditProject

    string

    The SLS project for audit logs.

    k8s-log-custom-your-project-sd89ehaaa
    AuditLogStore

    string

    The SLS Logstore for audit logs.

    audit-cf6baf6afa106eca665296fdf68b65bf
    CpuArch

    string

    The CPU architecture, which can be ARM architecture or x86 architecture. Examples:

    • arm64

    • x86

    x86

    Examples

    Success response

    JSON format

    {
  "RequestId": "061955B2-BC40-589F-AF63-C40A901EE279",
  "Data": {
    "ClusterName": "test",
    "AliUid": 0,
    "InstallKey": "BC66185***",
    "ClusterId": "c8ca91e0907d94efaba7fb0827eb9****",
    "GroupId": "11618788",
    "ExpireDate": 1804230578566,
    "AuditRegionId": "cn-hangzhou",
    "AuditProject": "k8s-log-custom-your-project-sd89ehaaa",
    "AuditLogStore": "audit-cf6baf6afa106eca665296fdf68b65bf",
    "CpuArch": "x86\n"
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 -101 Invalid parameter value. Invalid parameter.
    500 ServerError ServerError
    403 NoPermission caller has no permission You are not authorized to do this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.