Patch Sddcs

Patch Sddcs

Patch SDDC

Request
URI
PATCH
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}
COPY
Path Parameters
string
org
Required

Organization identifier

string
sddc
Required

Sddc identifier


Request Body

Patch request for the SDDC

SddcPatchRequest of type(s) application/json
Required
{
    "name": "string"
}
string
name
Optional

The new name of the SDDC to be changed to.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Sddc of type(s) application/json
This response body class contains all of the following: AbstractEntity
{
    "updated": "string",
    "user_id": "string",
    "updated_by_user_id": "string",
    "created": "string",
    "version": 5,
    "updated_by_user_name": "string",
    "user_name": "string",
    "id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "name": "string",
    "sddc_state": "string",
    "expiration_date": "string",
    "org_id": "string",
    "sddc_type": "string",
    "provider": "string",
    "account_link_state": "string",
    "sddc_access_state": "string",
    "resource_config": {
        "backup_restore_bucket": "string",
        "public_ip_pool": [
            {
                "public_ip": "string",
                "name": "string",
                "allocation_id": "string",
                "dnat_rule_id": "string",
                "associated_private_ip": "string",
                "snat_rule_id": "string"
            }
        ],
        "vpc_info": {
            "esx_security_group_id": "string",
            "vpc_cidr": "string",
            "vgw_id": "string",
            "esx_public_security_group_id": "string",
            "vif_ids": [
                "string"
            ],
            "vm_security_group_id": "string",
            "route_table_id": "string",
            "edge_subnet_id": "string",
            "id": "string",
            "api_association_id": "string",
            "api_subnet_id": "string",
            "private_subnet_id": "string",
            "private_association_id": "string",
            "vcdr_enis": [
                {
                    "secondary_ips": [
                        "string"
                    ],
                    "attachment_id": "string",
                    "association_id": "string",
                    "vmk_id": "string",
                    "security_group_id": "string",
                    "instance_id": "string",
                    "subnet_id": "string",
                    "public_ips": [
                        "string"
                    ],
                    "private_ip": "string",
                    "mac_address": "string",
                    "source_dest_check_false": false,
                    "portgroup": "string",
                    "id": "string"
                }
            ],
            "subnet_id": "string",
            "internet_gateway_id": "string",
            "security_group_id": "string",
            "association_id": "string",
            "vgw_route_table_id": "string",
            "traffic_group_edge_vm_ips": [
                "string"
            ],
            "edge_association_id": "string",
            "provider": "string",
            "peering_connection_id": "string",
            "network_type": "string",
            "available_zones": [
                {
                    "subnets": [
                        {
                            "subnet_id": "string",
                            "name": "string",
                            "route_tables": [
                                {
                                    "subnet_id": "string",
                                    "association_id": "string",
                                    "routetable_id": "string"
                                }
                            ]
                        }
                    ],
                    "id": "string"
                }
            ]
        },
        "kms_vpc_endpoint": {
            "vpc_endpoint_id": "string",
            "network_interface_ids": [
                "string"
            ]
        },
        "max_num_public_ip": 0,
        "esx_instance_profile": {
            "role_name": "string",
            "instance_profile_name": "string",
            "policy_name": "string"
        },
        "account_link_sddc_config": [
            {
                "customer_subnet_ids": [
                    "string"
                ],
                "connected_account_id": "string"
            }
        ],
        "vsan_encryption_config": {
            "port": 0,
            "certificate": "string"
        },
        "nsx_user_client": {
            "redirect_uris": [
                "string"
            ],
            "accessTokenTTL": 0,
            "redirect_uri": "string",
            "grant_types": [
                "string"
            ],
            "org_id": "string",
            "secret": "string",
            "refreshTokenTTL": 0,
            "resource_link": "string",
            "id": "string"
        },
        "vpc_info_peered_agent": {
            "esx_security_group_id": "string",
            "vpc_cidr": "string",
            "vgw_id": "string",
            "esx_public_security_group_id": "string",
            "vif_ids": [
                "string"
            ],
            "vm_security_group_id": "string",
            "route_table_id": "string",
            "edge_subnet_id": "string",
            "id": "string",
            "api_association_id": "string",
            "api_subnet_id": "string",
            "private_subnet_id": "string",
            "private_association_id": "string",
            "vcdr_enis": [
                {
                    "secondary_ips": [
                        "string"
                    ],
                    "attachment_id": "string",
                    "association_id": "string",
                    "vmk_id": "string",
                    "security_group_id": "string",
                    "instance_id": "string",
                    "subnet_id": "string",
                    "public_ips": [
                        "string"
                    ],
                    "private_ip": "string",
                    "mac_address": "string",
                    "source_dest_check_false": false,
                    "portgroup": "string",
                    "id": "string"
                }
            ],
            "subnet_id": "string",
            "internet_gateway_id": "string",
            "security_group_id": "string",
            "association_id": "string",
            "vgw_route_table_id": "string",
            "traffic_group_edge_vm_ips": [
                "string"
            ],
            "edge_association_id": "string",
            "provider": "string",
            "peering_connection_id": "string",
            "network_type": "string",
            "available_zones": [
                {
                    "subnets": [
                        {
                            "subnet_id": "string",
                            "name": "string",
                            "route_tables": [
                                {
                                    "subnet_id": "string",
                                    "association_id": "string",
                                    "routetable_id": "string"
                                }
                            ]
                        }
                    ],
                    "id": "string"
                }
            ]
        },
        "nsx_service_client": {
            "redirect_uris": [
                "string"
            ],
            "accessTokenTTL": 0,
            "redirect_uri": "string",
            "grant_types": [
                "string"
            ],
            "org_id": "string",
            "secret": "string",
            "refreshTokenTTL": 0,
            "resource_link": "string",
            "id": "string"
        }
    }
}

400

SDDC cannot be patched

Returns ErrorResponse of type(s) application/json
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Returns ErrorResponse of type(s) application/json
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


404

Cannot find the SDDC with given identifier

Returns ErrorResponse of type(s) application/json
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages